changelog cli namespace

docs-builder changelog --help

The changelog commands manage a file-per-change workflow that produces release notes with a consistent layout across all your products. Each developer creates a small YAML file per pull request; you later bundle those files into a release artifact and render it into Markdown or AsciiDoc.

add

Create a new changelog entry YAML file.
backfill

Backfill changelog entries, notes, and bundles from published release-notes pages.
bundle

Aggregate changelog entries matching a filter into a single bundle YAML.
bundle-amend

Append or exclude changelog entries in a published bundle without modifying it.
evaluate-artifact

(CI) Evaluate downloaded artifact in the resolving workflow.
evaluate-pr

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

Create changelog entries from the PRs referenced in a GitHub release.
init

Create changelog.yml and the changelog/releases directory structure.
note

Create a note-*.yml changelog fragment for items that have no associated PR.
prepare-artifact

(CI) Package changelog artifact for cross-workflow transfer.
remove

Delete changelog entry files matching a filter.
render

Render one or more changelog bundles to Markdown or AsciiDoc.
scrubber-allowlist

Resolve the link allowlist identity of the deployed changelog scrubber.
upload

Upload changelog entries or bundle artifacts to S3 or Elasticsearch.
validate

(CI and local) Validate changelog entry files that a PR added or modified. Checks YAML validity, required fields, config-value membership, PR existence, and entry hygiene. Exits non-zero on any error-level finding; warnings do not block.
validate-labels

(CI) Validate PR labels against the changelog config without writing any files or calling the GitHub API.
validate-onboarding

Validate that every product registered with features.release-notes: prestage has the required onboarding files in its repository.
  1. Configure — create docs/changelog.yml with label mappings and bundle profiles: docs-builder changelog init
  2. Create — add a changelog YAML for each notable PR: docs-builder changelog add. For items not tied to a PR (known issues, advisories), use docs-builder changelog note.
  3. Bundle — aggregate entries for a release: docs-builder changelog bundle
  4. Publish — render the bundle to a release notes page: docs-builder changelog render

When working in CI, docs-builder changelog evaluate-pr inspects an open pull request and decides whether it needs a changelog file, then sets GitHub Actions outputs so your workflow can gate on the result.

See Create release notes from changelogs for the end-to-end guide.