-
Notifications
You must be signed in to change notification settings - Fork 25.8k
[DOCS] Add changelog configuration file #140141
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
ℹ️ Important: Docs version tagging👋 Thanks for updating the docs! Just a friendly reminder that our docs are now cumulative. This means all 9.x versions are documented on the same page and published off of the main branch, instead of creating separate pages for each minor version. We use applies_to tags to mark version-specific features and changes. Expand for a quick overviewWhen to use applies_to tags:✅ At the page level to indicate which products/deployments the content applies to (mandatory) What NOT to do:❌ Don't remove or replace information that applies to an older version 🤔 Need help?
|
Relates to elastic/docs-builder#2350
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
Most of the existing "areas" were derived from https://github.com/elastic/elasticsearch/blob/main/build-tools-internal/src/main/resources/changelog-schema.json
There were some area labels and types for which I couldn't currently find a mapping in https://github.com/elastic/elasticsearch-serverless/labels so I've commented them out for now.
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:Check 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 test theadd_blockersclause. 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: