Skip to content

Conversation

mergify[bot]
Copy link
Contributor

@mergify mergify bot commented Sep 16, 2025

🍷 Pairs with elastic/elastic-agent-changelog-tool#213

What does this PR do?

Adds generated Markdown Elastic Agent release notes here instead in the docs-content repo.

Why is it important?

Currently the Elastic Agent team generates release notes in AsciiDoc in this repo and the @elastic/ingest-docs team has to manually translate AsciiDoc to Markdown, copy to another repo (docs-content), split into multiple files, and integrate with Fleet Server release notes. This is time consuming for the docs team and often leads to delays in publishing release notes.

In elastic/elastic-agent-changelog-tool#213, I updated the automation to allow generating Markdown, formatting it, and putting it into the correct files directly using elastic-agent-changelog-tool. This is the elastic-agent output when generating the release notes using the colleenmcginnis:markdown branch of elastic-agent-changelog-tool.

Checklist

  • I have read and understood the pull request guidelines of this project.
  • My code follows the style guidelines of this project
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have made corresponding change to the default configuration files
  • I have added tests that prove my fix is effective or that my feature works
  • I have added an entry in ./changelog/fragments using the changelog tool
  • I have added an integration test or an E2E test

Disruptive User Impact

This approach to release notes would mean splitting the source files for Fleet Server and Elastic Agent release notes, but they would still live next to each other on the docs site.

Screenshot 2025-08-18 at 11 00 53 AM

How to test this PR locally

This repo is not currently hooked up to the docs build system so we don't have a PR preview yet, but you can build the docs locally.

Screenshot 2025-08-18 at 10 53 56 AM

Note: Right now it will build independently from the rest of the Release notes, but once this repo is hooked up to the docs build system, these release notes will be integrated into the larger Release notes table of contents.

Related issues

Questions to ask yourself

  • How are we going to support this in production?
  • How are we going to measure its adoption?
  • How are we going to debug this?
  • What are the metrics I should take care of?
  • ...

cc @ebeahan @pierrehilbert @bmorelli25


This is an automatic backport of pull request #9440 done by Mergify.

* add config.changelog.yaml

* add changelog yml files

* check 9.1.2 output

* check 9.1.1 output

* check 9.1.0 output

* update 9.1.0.yaml

* check 9.0.5 output

* check 9.0.4 output

* check 9.0.3 output

* check 9.0.2 output

* check 9.0.1 output

* check 9.0.0 output

* clean up yaml files

* remaining formatting fixes

* add build out docs-builder content

* fix build errors

* add links to other pages

* add 9.0.6 release notes

* add 9.1.3 release notes

(cherry picked from commit 86fd0df)

# Conflicts:
#	changelog/9.0.1.yaml
#	changelog/9.0.2.yaml
#	changelog/9.0.3.yaml
#	changelog/9.0.6.yaml
#	docs/docset.yml
#	docs/release-notes/index.md
#	docs/release-notes/toc.yml
@mergify mergify bot added the backport label Sep 16, 2025
@mergify mergify bot requested a review from a team as a code owner September 16, 2025 17:27
@mergify mergify bot added the conflicts There is a conflict in the backported pull request label Sep 16, 2025
@mergify mergify bot requested review from michalpristas and straistaru and removed request for a team September 16, 2025 17:27
@mergify mergify bot added the conflicts There is a conflict in the backported pull request label Sep 16, 2025
@mergify mergify bot added the backport label Sep 16, 2025
Copy link
Contributor Author

mergify bot commented Sep 16, 2025

Cherry-pick of 86fd0df has failed:

On branch mergify/bp/9.0/pr-9440
Your branch is up to date with 'origin/9.0'.

You are currently cherry-picking commit 86fd0df04.
  (fix conflicts and run "git cherry-pick --continue")
  (use "git cherry-pick --skip" to skip this patch)
  (use "git cherry-pick --abort" to cancel the cherry-pick operation)

Changes to be committed:
	new file:   changelog/9.0.5.yaml
	new file:   changelog/9.1.0.yaml
	new file:   changelog/9.1.1.yaml
	new file:   changelog/9.1.2.yaml
	new file:   changelog/9.1.3.yaml
	new file:   config.changelog.yaml
	new file:   docs/release-notes/_snippets/9.0.0/breaking.md
	new file:   docs/release-notes/_snippets/9.0.0/deprecations.md
	new file:   docs/release-notes/_snippets/9.0.0/index.md
	new file:   docs/release-notes/_snippets/9.0.1/breaking.md
	new file:   docs/release-notes/_snippets/9.0.1/deprecations.md
	new file:   docs/release-notes/_snippets/9.0.1/index.md
	new file:   docs/release-notes/_snippets/9.0.2/breaking.md
	new file:   docs/release-notes/_snippets/9.0.2/deprecations.md
	new file:   docs/release-notes/_snippets/9.0.2/index.md
	new file:   docs/release-notes/_snippets/9.0.3/breaking.md
	new file:   docs/release-notes/_snippets/9.0.3/deprecations.md
	new file:   docs/release-notes/_snippets/9.0.3/index.md
	new file:   docs/release-notes/_snippets/9.0.4/breaking.md
	new file:   docs/release-notes/_snippets/9.0.4/deprecations.md
	new file:   docs/release-notes/_snippets/9.0.4/index.md
	new file:   docs/release-notes/_snippets/9.0.5/breaking.md
	new file:   docs/release-notes/_snippets/9.0.5/deprecations.md
	new file:   docs/release-notes/_snippets/9.0.5/index.md
	new file:   docs/release-notes/_snippets/9.0.6/breaking.md
	new file:   docs/release-notes/_snippets/9.0.6/deprecations.md
	new file:   docs/release-notes/_snippets/9.0.6/index.md
	new file:   docs/release-notes/_snippets/9.1.0/breaking.md
	new file:   docs/release-notes/_snippets/9.1.0/deprecations.md
	new file:   docs/release-notes/_snippets/9.1.0/index.md
	new file:   docs/release-notes/_snippets/9.1.1/breaking.md
	new file:   docs/release-notes/_snippets/9.1.1/deprecations.md
	new file:   docs/release-notes/_snippets/9.1.1/index.md
	new file:   docs/release-notes/_snippets/9.1.2/breaking.md
	new file:   docs/release-notes/_snippets/9.1.2/deprecations.md
	new file:   docs/release-notes/_snippets/9.1.2/index.md
	new file:   docs/release-notes/_snippets/9.1.3/breaking.md
	new file:   docs/release-notes/_snippets/9.1.3/deprecations.md
	new file:   docs/release-notes/_snippets/9.1.3/index.md
	new file:   docs/release-notes/_snippets/breaking-changes.md
	new file:   docs/release-notes/_snippets/deprecations.md
	new file:   docs/release-notes/_snippets/index.md
	new file:   docs/release-notes/breaking-changes.md
	new file:   docs/release-notes/deprecations.md
	new file:   docs/release-notes/known-issues.md

Unmerged paths:
  (use "git add/rm <file>..." as appropriate to mark resolution)
	both added:      changelog/9.0.1.yaml
	both added:      changelog/9.0.2.yaml
	both added:      changelog/9.0.3.yaml
	both added:      changelog/9.0.6.yaml
	deleted by us:   docs/docset.yml
	deleted by us:   docs/release-notes/index.md
	deleted by us:   docs/release-notes/toc.yml

To fix up this pull request, you can check it out locally. See documentation: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally

@github-actions github-actions bot added Team:Docs Label for the Observability docs team docs skip-changelog labels Sep 16, 2025
@karenzone
Copy link
Contributor

Backporting to 9.0 to support our release notes process

Copy link
Contributor

@colleenmcginnis colleenmcginnis enabled auto-merge (squash) September 16, 2025 21:19
@ebeahan ebeahan mentioned this pull request Sep 16, 2025
Copy link

Quality Gate passed Quality Gate passed

Issues
0 New issues
0 Fixed issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarQube

@colleenmcginnis colleenmcginnis merged commit 88fa44f into 9.0 Sep 16, 2025
14 of 15 checks passed
@colleenmcginnis colleenmcginnis deleted the mergify/bp/9.0/pr-9440 branch September 16, 2025 21:37
@elasticmachine
Copy link
Collaborator

💚 Build Succeeded

History

cc @colleenmcginnis

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

Labels

backport conflicts There is a conflict in the backported pull request docs skip-changelog Team:Docs Label for the Observability docs team

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants