chore: added workflow for changelog file - #495
Open
shazib-summar wants to merge 1 commit into
Open
Conversation
This commit introduces a github actions workflow to introduce a CHANGELOG.md file that is automatically updated when a new GitHub release is published in this repo. The automated-changelog-gh action is added in `prepend` mode i.e. when triggered through a release publishing it will prepend the CHANGELOG.md file with the changelog for the latest release. This ensure any manual changes are reserved but requires us to instantiate a CHANGELOG.md file with the changelog for previous releases backfilled. This can be simply done by heading over to the Actions tab in the repo and running it manually for the first time with mode set to `full`. The github-actions[bot] will open a PR instead of pushing commit directly to the default branch. Resolves temporalio#296
shazib-summar
requested review from
a team,
eniko-dif and
jlegrone
as code owners
August 3, 2026 14:08
|
|
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
2 participants
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.
What was changed
This commit introduces a github actions workflow to introduce a CHANGELOG.md file that is automatically updated when a new GitHub release is published in this repo. The automated-changelog-gh action is added in
prependmode i.e. when triggered through a release publishing it will prepend the CHANGELOG.md file with the changelog for the latest release. This ensure any manual changes are reserved but requires us to instantiate a CHANGELOG.md file with the changelog for previous releases backfilled.This can be simply done by heading over to the Actions tab in the repo and running it manually for the first time with mode set to
full.The
github-actions[bot]will always open a PR instead of pushing commit directly to the default branch.Why?
To maintain a changelog little to none maintenance.
Closes Automate curation of a CHANGELOG #296
How was this tested:
Tested in my fork.
See the commits in this branch: main...shazib-summar:temporal-worker-controller:automated-changelog-test
See these PRs as an example of what this bot is intended to do: docs(changelog): update changelog for v1.9.1 shazib-summar/temporal-worker-controller#6 and docs(changelog): update changelog for v1.9.1 shazib-summar/temporal-worker-controller#4
Any docs updates needed?
No