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.
Create a new changelog entry YAML file.
Aggregate changelog entries matching a filter into a single bundle YAML.
Append or exclude changelog entries in a published bundle without modifying it.
(CI) Evaluate downloaded artifact in the resolving workflow.
(CI) Evaluate a pull request for changelog generation eligibility and set GitHub Actions outputs.
Create changelog entries from the PRs referenced in a GitHub release.
Create changelog.yml and the changelog/releases directory structure.
TEMPORARY: One-off migration of published release notes into the S3 bundle store; removed after elastic/docs-eng-team#683.
(CI) Package changelog artifact for cross-workflow transfer.
Delete changelog entry files matching a filter.
Render one or more changelog bundles to Markdown or AsciiDoc.
Resolve the link allowlist identity of the deployed changelog scrubber.
Upload changelog entries or bundle artifacts to S3 or Elasticsearch.
Validate that every product registered with features.release-notes: prestage has the required onboarding files in its repository.
- Configure — create
docs/changelog.ymlwith label mappings and bundle profiles:docs-builder changelog init - Create — add a changelog YAML for each notable PR:
docs-builder changelog add - Bundle — aggregate entries for a release:
docs-builder changelog bundle - 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.