Skip to content

release notes switch to docs-builder yaml#1023

Open
SylvainJuge wants to merge 21 commits intoelastic:mainfrom
SylvainJuge:release-notes
Open

release notes switch to docs-builder yaml#1023
SylvainJuge wants to merge 21 commits intoelastic:mainfrom
SylvainJuge:release-notes

Conversation

@SylvainJuge
Copy link
Copy Markdown
Member

@SylvainJuge SylvainJuge commented Mar 26, 2026

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-builder to 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:

./wip-changelog.sh

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:

  • review all TODOs in this PR and either create issues/PRs in docs-builder or provide ways to achieve what is necessary.
  • find a way to generate github release notes markdown from a single bundle
  • generate changelog in markdown to replace current static release-notes
    • we could decide to make this optional and link to docs directly
    • UPDATE: it hasn't been updated since 1.5.0, so I've decided to remove it.
  • add automation in CI to require new PRs to be tagged so they are included in future changelogs + add changelog entries automatically
  • remove ./wip-changelog.sh
  • make it ready for merge: catch-up with any merged PR in the mean time

@SylvainJuge SylvainJuge self-assigned this Mar 26, 2026
@lcawl
Copy link
Copy Markdown
Member

lcawl commented Mar 28, 2026

I don't have authority to push commits to this PR, so I created SylvainJuge#1

@lcawl
Copy link
Copy Markdown
Member

lcawl commented Apr 2, 2026

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
@github-actions
Copy link
Copy Markdown

github-actions bot commented Apr 3, 2026

📋 Changelog

⚠️ Cannot generate changelog: no matching type label found on this PR.

🔖 Add one of these type labels to your PR:

Label Type
breaking-change breaking-change
bug bug-fix
deprecation deprecation
feature feature
enhancement enhancement
changelog:upstream-update enhancement
docs docs
documentation docs

🔖 To skip changelog generation or configure label rules, see docs/changelog.yml.

@github-actions
Copy link
Copy Markdown

github-actions bot commented Apr 3, 2026

@github-actions
Copy link
Copy Markdown

github-actions bot commented Apr 3, 2026

✅ Vale Linting Results

No 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.

@SylvainJuge
Copy link
Copy Markdown
Member Author

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.

@SylvainJuge SylvainJuge changed the title [wip] release notes automation release notes switch to docs-builder yaml Apr 9, 2026
@SylvainJuge SylvainJuge marked this pull request as ready for review April 9, 2026 15:40
@SylvainJuge SylvainJuge requested review from a team as code owners April 9, 2026 15:40
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 9, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: b349f666-5b5f-4317-a692-59395aa7b819

📥 Commits

Reviewing files that changed from the base of the PR and between b100c12 and 2d40535.

📒 Files selected for processing (5)
  • docs/release-notes/breaking-changes.md
  • docs/release-notes/deprecations.md
  • docs/release-notes/index.md
  • docs/release-notes/known-issues.md
  • docs/releases/1.10.0.amend-1.yaml

📝 Walkthrough

Walkthrough

This 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 /releases/ directory. Four release notes documents are modified to replace hardcoded template sections and placeholder text with directive blocks (:::{changelog}), and a new release entry file (1.10.0.amend-1.yaml) is added to document a security item for version 1.10.0.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • 🛠️ Update Documentation: Commit on current branch
  • 🛠️ Update Documentation: Create PR

Warning

Review ran into problems

🔥 Problems

Timed out fetching pipeline failures after 30000ms


Comment @coderabbitai help to get the list of available commands and usage tips.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants