release notes switch to docs-builder yaml#1023
release notes switch to docs-builder yaml#1023SylvainJuge wants to merge 21 commits intoelastic:mainfrom
Conversation
|
I don't have authority to push commits to this PR, so I created SylvainJuge#1 |
|
I created SylvainJuge#2 to hopefully address the current docs build error. |
…ase-notes # Conflicts: # .ci/updatecli.d/bump-upstream-agent-version.yml # docs/changelog.yml # docs/releases/1.0.0.yaml # docs/releases/1.1.0.yaml # docs/releases/1.10.0.yaml # docs/releases/1.2.0.yaml # docs/releases/1.2.1.yaml # docs/releases/1.3.0.yaml # docs/releases/1.4.0.yaml # docs/releases/1.4.1.yaml # docs/releases/1.5.0.yaml # docs/releases/1.6.0.yaml # docs/releases/1.7.0.yaml # docs/releases/1.8.0.yaml # docs/releases/1.9.0.yaml
📋 Changelog🔖 Add one of these type labels to your PR:
🔖 To skip changelog generation or configure label rules, see |
🔍 Preview links for changed docs |
✅ Vale Linting ResultsNo issues found on modified lines! The Vale linter checks documentation changes against the Elastic Docs style guide. To use Vale locally or report issues, refer to Elastic style guide for Vale. |
|
I've updated the PR to contain only the final step of the migration process: replace current release notes in documentation with the changelog bundles. |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (5)
📝 WalkthroughWalkthroughThis change migrates the release notes documentation from a static, manually-maintained format to a dynamic system. The breaking-changes, deprecations, known-issues, and main index pages are updated to use Sphinx changelog directives that source entries from the ✨ Finishing Touches🧪 Generate unit tests (beta)
Warning Review ran into problems🔥 ProblemsTimed out fetching pipeline failures after 30000ms Comment |
EDIT: you can ignore this PR description and most of the conversation, the intermediate changes have already been merged as separate PRs.
This PR now contains the final switch from markdown release notes to the YAML generated by docs-builder.
Generation of the changelog bundles at release time is covered by #1047
Opened as a draft at this is a work-in-progress migration to using
docs-builderto generate changelog entries and release notes.Instructions provided here were used as a reference: elastic/elasticsearch#140795 (comment)
This will re-generate changelog entries from pull-requests and generate bundles, which emulates how each PR should have been gradually added to the changelog and how changelog bundles should be merged together at each release:
All the PRs that are part of the changelog have beep properly labelled so they can fit one of the defined types.
For upstream dependency updates, they are currently labelled with
enhancement, as they most often bring new enhancement and features from the SDK and the upstream implementation.Next steps:
./wip-changelog.sh