Skip to content

Conversation

@colleenmcginnis
Copy link
Contributor

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.

image

It automatically opens a PR adding the generated changelog.yml file, 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:

  • The @colleenmcginnis in the test PR will be replaced with the username of whoever triggered the job.
  • Currently the action won't automatically run the preview build because (I think) using the default GitHub action token restricts you from using that action to trigger another action. I'm not sure if there's an alternative we could use in this repo.

Proposed commit message

Add workflow for generating release notes using the latest version of elastic-agent-changelog-tool.

Checklist

  • 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. Where relevant, I have used the stresstest.sh script to run them under stress conditions and race detector to verify their stability.
  • I have added an entry in ./changelog/fragments using the changelog tool.

Disruptive User Impact

N/A

Author's Checklist

N/A

How to test this PR locally

N/A

Related issues

@colleenmcginnis colleenmcginnis self-assigned this Nov 4, 2025
@colleenmcginnis colleenmcginnis added ci Team:Docs Label for the Observability docs team backport-skip Skip notification from the automated backport with mergify skip-changelog labels Nov 4, 2025
@botelastic botelastic bot added needs_team Indicates that the issue/PR needs a Team:* label and removed needs_team Indicates that the issue/PR needs a Team:* label labels Nov 4, 2025
@github-actions
Copy link
Contributor

github-actions bot commented Nov 4, 2025

🤖 GitHub comments

Just comment with:

  • run docs-build : Re-trigger the docs validation. (use unformatted text in the comment!)

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

Labels

backport-skip Skip notification from the automated backport with mergify ci skip-changelog Team:Docs Label for the Observability docs team

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant