-
Notifications
You must be signed in to change notification settings - Fork 37
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add Github workflow to automate changelog and release pages #486
Conversation
Signed-off-by: Partho Sarthi <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks Partho!
It will be nice to update the user_tools README file to have a link to the CHANGELOG in the main branch. This is similar to what we have for the user-guide link.
Signed-off-by: Partho Sarthi <[email protected]>
Thanks @amahussein for the review. Updated the README file with link to CHANGELOG in main branch branch. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @parthosa
Just a few minor comments.
Signed-off-by: Partho Sarthi <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great Job @parthosa !
I am fine with PR.
One final issue that @mattahrens can reflect on:
For the upcoming release the changes will be added at the top of an empty changelog. Are you ok with that?
Or do you want to manually pre-populate the changelogs with some of the most recent releases?
It's fine to populate on top of an empty changelog. If needed, we can go back and add in later. |
Fixes #369
The release process within GitHub is automated using a GitHub Actions workflow script.
GitHub Release Workflow:
File -
.github/workflow/release.yml
This workflow is triggered when a branch prefixed with 'v*' is pushed. The following steps are executed:
CHANGELOG.md
in themain
branch.main
branch.File -
.github/workflow/configuration.json
A configuration file to customize the output of change logs.
Library Used - https://github.com/marketplace/actions/release-changelog-builder