Add workflow for generating release notes #47467
Draft
+27
−0
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds a GitHub workflow that can be manually triggered to generate release notes and open a PR.
As currently written, the workflow needs to be manually triggered by the control plane release manager (@ebeahan or @pierrehilbert). They need to provide the SHA of the build candidate for the release and the version number. The team could choose to trigger it another way in the future as long as they can pass it those two pieces of information.
It automatically opens a PR adding the generated
changelog.ymlfile, cleaning up fragments, and adding the relevant Markdown release note files. Here's the outcome from an earlier test in elastic-agent: colleenmcginnis/elastic-agent#2.A couple notes:
@colleenmcginnisin the test PR will be replaced with the username of whoever triggered the job.Proposed commit message
Add workflow for generating release notes using the latest version of elastic-agent-changelog-tool.
Checklist
stresstest.shscript to run them under stress conditions and race detector to verify their stability../changelog/fragmentsusing the changelog tool.Disruptive User Impact
N/A
Author's Checklist
N/A
How to test this PR locally
N/A
Related issues
generate-release-notesworkflow elastic-agent-changelog-tool#223