Loading

changelog evaluate-pr cli command

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.

--config string required
Path to the changelog.yml configuration file
--owner string required
GitHub repository owner
--repo string required
GitHub repository name
--pr-number int required
Pull request number
--pr-title string required
Pull request title
--pr-labels string required
Comma-separated PR labels
--head-ref string required
PR head branch ref
--head-sha string required
PR head commit SHA
--event-action string
Optional: GitHub event action (e.g., opened, synchronize, edited). When omitted, body-only-edit and bot-loop checks are skipped.
--[no-]title-changed

Whether the PR title changed (for edited events)

Default: false

--[no-]body-changed

Whether the PR body changed (for edited events)

Default: false

--[no-]strip-title-prefix

Remove square-bracket prefixes from the PR title

Default: false

--bot-name string

Bot login name for loop detection

Default: github-actions[bot]

-l --log-level enum

Minimum log level.

Values: trace, debug, information, warning, error, critical, none

Default: information

-c --config-source enum

Override the configuration source: local, remote

Values: local, remote, embedded

--[no-]skip-private-repositories
Skip cloning private repositories

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.