Add release changelog agentic workflow#638
Merged
SteveSandersonMS merged 2 commits intomainfrom Mar 3, 2026
Merged
Conversation
Create an AI agent that automatically generates CHANGELOG.md entries when a stable (non-preview) release is published. The agent: - Triggers on release:published events (filtered to non-prerelease) - Reads merged PRs/commits between the new and previous stable tags - Generates categorized, bullet-pointed changelog entries - Opens a PR to update CHANGELOG.md via create-pull-request safe output - Updates the GitHub Release notes via update-release safe output - Posts an announcement Discussion for team visibility Also adds a seed CHANGELOG.md at the repo root. Note: The .lock.yml must be compiled via 'gh aw compile release-changelog' before this workflow will run in CI. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
SteveSandersonMS
force-pushed
the
changelog-agent
branch
from
9b7f5e1 to
3d09b79
Compare
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a GitHub Agentic Workflow that generates and publishes changelog entries for stable releases, plus a seeded root CHANGELOG.md for the agent to update.
Changes:
- Add initial
CHANGELOG.mdheader/seed content at repo root. - Add
.github/workflows/release-changelog.mdagentic workflow to generate changelog entries, open a PR, and update GitHub Release notes.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
CHANGELOG.md |
Adds the initial changelog file the workflow will prepend entries to. |
.github/workflows/release-changelog.md |
Defines the agentic workflow instructions and safe outputs for PR creation + release note updates. |
Comments suppressed due to low confidence (1)
.github/workflows/release-changelog.md:80
- Using “today’s date” will produce incorrect changelog dates when the workflow is run manually for an older tag (and can also differ from the actual release publish date). Prefer using the release’s
published_atdate (fetch it by tag forworkflow_dispatch) to keep CHANGELOG and GitHub Release metadata consistent.
3. Use today's date for the release date.
- Add explicit guidance for workflow_dispatch runs where release event fields are empty (fetch release by tag via API) - Use release publish date instead of today's date for changelog entries - Remove author attribution to match example style (keep it clean) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Adds an AI agent that automatically generates
CHANGELOG.mdentries when a stable (non-preview) release is published.How it works
dist-tag: latestcreates a GitHub Releaserelease: publishedevent triggers this agentic workflow (filtered to non-prerelease)CHANGELOG.mdto find the last documented version, then gathers merged PRs/commits since that tagCHANGELOG.mdviacreate-pull-requestsafe outputupdate-releasesafe outputAlso supports
workflow_dispatchfor manual runs against any tag.Files
.github/workflows/release-changelog.md— agentic workflow sourceCHANGELOG.md— seed file at repo rootBefore merging
The
.lock.ymlmust be compiled viagh aw compile release-changelogbefore this workflow will run in CI.