fix: move changelog update into release workflow [2.x]#117
Merged
ManukMinasyan merged 1 commit into2.xfrom Mar 18, 2026
Merged
Conversation
The standalone changelog.yml triggers on `release: released` events, but releases created by GITHUB_TOKEN don't fire this event (GitHub anti-recursion). Move changelog logic into the release workflow as an inline job that runs after the release is created.
There was a problem hiding this comment.
Pull request overview
Moves the changelog update logic from a standalone changelog.yml (triggered by on: release) into the existing tag-driven release.yml workflow to ensure the changelog update runs even when the release is created by the workflow itself.
Changes:
- Adds an inline
changelogjob torelease.ymlthat fetches release notes and updatesCHANGELOG.mdon the appropriate maintenance branch. - Removes the standalone
changelog.ymlworkflow that relied onon: releaseevents.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| .github/workflows/release.yml | Adds a changelog job that determines the target branch, fetches release notes via gh, updates CHANGELOG.md, and commits it back. |
| .github/workflows/changelog.yml | Removes the now-redundant release-event-driven changelog workflow. |
Comment on lines
+84
to
+94
| - name: Update Changelog | ||
| uses: stefanzweifel/changelog-updater-action@v1 | ||
| with: | ||
| latest-version: ${{ github.ref_name }} | ||
| release-notes: ${{ steps.notes.outputs.body }} | ||
|
|
||
| - name: Commit updated CHANGELOG | ||
| uses: stefanzweifel/git-auto-commit-action@v7 | ||
| with: | ||
| branch: ${{ steps.branch.outputs.name }} | ||
| commit_message: "chore: update CHANGELOG for ${{ github.ref_name }}" |
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
Moves changelog update logic from standalone
changelog.ymlinto therelease.ymlworkflow as an inlinechangelogjob.Why
Releases created by
GITHUB_TOKENdon't triggeron: releaseevents (GitHub anti-recursion rule). The standalonechangelog.ymlnever fires when the Release workflow auto-creates a release. By inlining it, the changelog update runs as part of the same workflow.The deploy key (
DEPLOY_KEY) bypasses the branch ruleset to push directly.