Repository navigation
[DOCS] Read changelog entries with the elasticsearch entry format - #162667
theletterf wants to merge 1 commit into
Conversation
Set entry_format: elasticsearch in docs/changelog.yml so docs-builder converts the entry files in docs/changelog, and list the changelog schema areas that had no pivot.areas key. Add the shared release-notes workflow, which validates entry files and labels on pull requests and uploads the converted entries on push to main. Related to elastic/docs-eng-team#1106 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01TjZFCvQhL3DdrcjFKU6jDT
🔍 Preview links for changed docs⏳ Building and deploying preview... View progress This comment will be updated with preview links when the build is complete. |
|
Pinging @elastic/core-docs (:Docs/General) |
|
Pinging @elastic/core-docs (Team:Docs) |
ℹ️ 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?
|
This gets Elasticsearch ready for the shared release notes automation without changing how anyone writes changelog entries.
Today docs-builder can't read the files in
docs/changelog/, because they use the Elasticsearch format (summary,area, thebreaking/deprecation/highlightblocks) rather than docs-builder's. elastic/docs-builder#4528 adds entry formats that a repository selects in itschangelog.yml, and ships anelasticsearchformat based onbuild-tools-internal/src/main/resources/changelog-schema.json.What this PR changes:
docs/changelog.yml: setsentry_format: elasticsearch, and adds the five schema areas that had nopivot.areaskey (DLM,Features,Graph,Ingest,Java High Level REST Client) without labels, so entries that use them validate. The format already translatesSnapshot/RestoreandExtract&Transformto the names this file uses..github/workflows/release-notes.yml: the shared caller fromelastic/docs-actions. On pull requests it checks the type label and validates any entry file the PR adds; on push tomainit uploads the entries, converted, to the changelog pool that unified and Serverless release notes read.I checked it with a local build of #4528: all 718 files in
docs/changelog/onmainvalidate with this config, and the label check passed 298 of the last 300 merged PRs (one had no type label, one had two).Don't merge yet.
entry_formatis a new key, and docs-builder releases before #4528 reject unknown keys, so this has to wait until #4528 is merged and in theedgebuild that the workflows and the Serverless promotion use. I'll mark it ready then.Not in this PR:
release-notes / validateisn't a required check. If it becomes one, the caller needs amerge_grouptrigger for the merge queue.Related to elastic/docs-eng-team#1106
🤖 Generated with Claude Code
https://claude.ai/code/session_01TjZFCvQhL3DdrcjFKU6jDT