feat: configure automated changelog generation #237
Merged
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.
Description
This PR introduces the Create Changelog and Release workflows.
When a commit is pushed to a
release/*
branch (e.g., release/1.0.0, release/1.0.1, etc.), thecreate-changelog.yml
workflow is triggered to generate or update theCHANGELOG.md
file and create a corresponding PR.The
create-changelog.yml
workflow utilizes thegoogleapis/release-please-action@v4
library to identify the changes made between the previous version and the current version, then generates or updates theCHANGELOG.md
file accordingly.Once the changelog PR is merged into the release branch, the release preparation is considered complete. At this point, the
release
branch can be merged into themain
branch. This action triggers therelease.yml
workflow, which generates a new tag and creates a corresponding GitHub release. With these steps, the release process is finalized.What type of PR is this? (check all applicable)
Related Tickets & Documents
https://github.com/gs-gs/fa-ag-trace/issues/848
Mobile & Desktop Screenshots/Recordings
release/*
branch:create-changelog.yml
workflow:After the
release
is merged into themain
branch:A tag is automatically created by the
release.yml
workflow, and its value corresponds to theversion
defined in theversion.json
file:A GitHub release is automatically created once the tag is successfully generated. The release notes for this step are automatically generated by the
create-changelog.yml
workflowAdded tests?
Added to documentation?
[optional] Are there any post-deployment tasks we need to perform?
[optional] What gif best describes this PR or how it makes you feel?