changelog validate-labels cli command
docs-builder changelog validate-labels --config <file> --pr-labels <string>
This command is intended for CI automation. It is used internally by the changelog GitHub Actions and is not typically invoked directly by users.
Validate that a pull request's labels contain a recognised changelog type label, and optionally a product label. Unlike changelog evaluate-pr, this command performs no GitHub API access, no title resolution, no bot-loop detection, and no manual-edit detection — it only resolves labels against the configured pivot.types, pivot.products, and rules.create settings. This makes it safe to run on pull_request events from forks without write permissions.
Exits non-zero when status is no-label. All other statuses (ok, skipped) exit zero.
--configstringrequired-
Path to the changelog.yml configuration file.
Constraints: extensions: yml, yaml
--pr-labelsstringrequired- Comma-separated list of PR labels (use ${{ join(github.event.pull_request.labels.*.name, ',') }} in actions).
-l--log-levelenum-
Minimum log level.
Values: trace, debug, information, warning, error, critical, none
Default:
information -c--config-sourceenum-
Override the configuration source: local, remote
Values: local, remote, embedded
--skip-private-repositories- Skip cloning private repositories
-l--log-levelenum-
Minimum log level.
Values: trace, debug, information, warning, error, critical, none
Default:
information -c--config-sourceenum-
Override the configuration source: local, remote
Values: local, remote, embedded
--skip-private-repositories- Skip cloning private repositories
| Output | Description |
|---|---|
status |
Validation result: ok, no-label, or skipped |
type |
Resolved changelog type (when ok) |
products |
Comma-separated product specs resolved from PR labels (when resolved) |
label-table |
Markdown table of configured label-to-type mappings (when no-label) |
product-label-table |
Markdown table of configured label-to-product mappings (when no-label due to missing product) |
skip-labels |
Comma-separated list of configured skip labels (from rules.create exclude rules) |
docs-builder changelog validate-labels \
--config docs/changelog.yml \
--pr-labels "enhancement,Team:Core"