---
title: changelog evaluate-pr cli command
description: (CI) Evaluate a pull request for changelog generation eligibility and set GitHub Actions outputs. Runs pre-flight checks (body-only edit, bot loop, manual...
url: https://docs-v3-preview.elastic.dev/elastic/docs-builder/pull/2927/cli/changelog/evaluate-pr
products:
  - Elastic Docs Builder
---

# changelog evaluate-pr cli command
```bash
docs-builder changelog evaluate-pr \
  --config <file> \
  --owner <string> \
  --repo <string> \
  --pr-number <int> \
  --pr-title <string> \
  --pr-labels <string> \
  --head-ref <string> \
  --head-sha <string> \
  [options]
```

(CI) Evaluate a pull request for changelog generation eligibility and set GitHub Actions outputs.

## Options

<definitions>
  <definition term="--config string required">
    Path to the changelog.yml configuration file
    **Constraints:** extensions: yml, yaml
  </definition>
  <definition term="--owner string required">
    GitHub repository owner
  </definition>
  <definition term="--repo string required">
    GitHub repository name
  </definition>
  <definition term="--pr-number int required">
    Pull request number
  </definition>
  <definition term="--pr-title string required">
    Pull request title
  </definition>
  <definition term="--pr-labels string required">
    Comma-separated PR labels
  </definition>
  <definition term="--head-ref string required">
    PR head branch ref
  </definition>
  <definition term="--head-sha string required">
    PR head commit SHA
  </definition>
  <definition term="--event-action string">
    Optional: GitHub event action (e.g., opened, synchronize, edited). When omitted, body-only-edit and bot-loop checks are skipped.
  </definition>
  <definition term="--[no-]title-changed">
    Whether the PR title changed (for edited events)
    **Default:** `false`
  </definition>
  <definition term="--[no-]body-changed">
    Whether the PR body changed (for edited events)
    **Default:** `false`
  </definition>
  <definition term="--[no-]strip-title-prefix">
    Remove square-bracket prefixes from the PR title
    **Default:** `false`
  </definition>
  <definition term="--bot-name string">
    Bot login name for loop detection
    **Default:** `github-actions[bot]`
  </definition>
  <definition term="-l --log-level enum">
    Minimum log level.
    **Values:** trace, debug, information, warning, error, critical, none
    **Default:** `information`
  </definition>
  <definition term="-c --config-source enum">
    Override the configuration source: local, remote
    **Values:** local, remote, embedded
  </definition>
  <definition term="--[no-]skip-private-repositories">
    Skip cloning private repositories
  </definition>
</definitions>


## Notes

Runs pre-flight checks (body-only edit, bot loop, manual edit), applies label rules from
changelog.yml, and resolves the entry type and title. Designed to be called from a
GitHub Actions workflow step.