[DOCS] Add changelog configuration file #247875
Draft
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Relates to elastic/docs-builder#2350
Summary
This PR adds a changelog configuration file, which contains things like the label to area mappings that will affect the creation of release notes per https://docs-v3-preview.elastic.dev/elastic/docs-builder/tree/main/contribute/changelog
The label mappings were derived from:
Examples
To test the use of this configuration file:
Install docs-builder.
Run the
docs-builder changelog addcommand to generate changelogs for a PR that uses the type and area labels that are included in thechangelog.yml. For example:docs-builder changelog add --pr https://github.com/elastic/kibana/pull/247465 \ --products "kibana 9.3.0" \ --config ./kibana/docs/changelog.yml \ --output ./kibana/docs/changelogCheck out Add PR label blockers to changelog creation docs-builder#2350 then refresh the docs-builder binaries per the readme:
Uncomment the
add_blockerssection of thechangelog.ymlfile.Run the
docs-builder changelog addcommand to generate changelogs for one or more pull requests. For example, from the.artifacts/publish/docs-builder/releasein the docs-builder repo:Re-comment the
add_blockerssection (unless that PR gets merged).Checkout Add changelog bundle and render commands docs-builder#2341 then refresh the docs-builder binaries (per earlier step).
Uncomment the
render_blockerssection of thechangelog.ymlfile.Run the
docs-builder changelog bundleanddocs-builder changelog rendercommands to generate docs that heed therender_blockersconfig. For example, from the.artifacts/publish/docs-builder/releasein the docs-builder repo: