-
Notifications
You must be signed in to change notification settings - Fork 6
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 changelog generation #72
Conversation
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.
Looks good, thanks!
- only the PR`s analogous to the changelog generation of GitHub are used
Yes, I guess since we don't do releases or semantic versioning anywhere, this is as good as it gets. PR titles are short but very descriptive – and the list of changes is already long (at least for this release)...
- Identifier in merges are used to retrieve the PR information from GitHub
There's probably a way to get to that directly via Github API, but let's stick with your method as long as it works.
currently the following adjustments are still necessary manually:
- change of the release version number
- change of the from and end commit references
I would expect your script to be embedded in a release procedure where a new tag is available on the HEAD, and so you would just need to go back to the previous tag to get a commit range. Or, for manual override, optional parameters.
- manual execution if
update_changelog.sh
using personal token as parameter
And from CI this could be passed on from Github Actions perhaps?
update_changelog.sh
Outdated
|
||
#echo "curl -L -H Accept: application/vnd.github+json -H Authorization: Bearer $token https://api.github.com/repos/$repo/pulls/$pull_request_id" | ||
curl -L -H "Accept: application/vnd.github+json" -H "Authorization: Bearer $token" https://api.github.com/repos/$repo/pulls/$pull_request_id | \ | ||
jq -r '[.title, .user.login] | @sh' | xargs printf "* %s by @%s in $url/pull/$pull_request_id\n" |
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.
nice pattern!
Co-authored-by: Robert Sachunsky <38561704+bertsky@users.noreply.github.com>
…ecific changes, modify update changelog script to autogenerate CHANGELOG.md without manual intervention
|
Add newline
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.
Fantastic!
update_changelog.sh
using personal token as parameter