-
Notifications
You must be signed in to change notification settings - Fork 1
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
Use GitHub usernames in changelogs for releases #115
Merged
Merged
Conversation
This file contains 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
Codecov Report
@@ Coverage Diff @@
## main #115 +/- ##
=======================================
Coverage 65.67% 65.67%
=======================================
Files 9 9
Lines 472 472
=======================================
Hits 310 310
Misses 162 162 Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. |
daniel-sintef
approved these changes
Mar 24, 2023
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.
Closes #102
Updates CD - Release to use the github-changelog-generator directly from the public Docker image, instead of the GitHub Actions CharMixer/auto-changelog-action, which essentially proxies usage of that same Docker image.
The reason for this switch is the need to use the
--usernames-as-github-logins
option, which is not supported by the proxy action. The action is quite static in terms of the supported options and does not allow one to add miscellaneous options.Instead, since GitHub Actions supports using public Docker images straight up as a step, this is done, passing in the options to the generator tool via the
args
input. It's a bit more opaque concerning the options passed to the generator tool now, however, the freedom to use whichever option we want is apparent.In order to parse the options correctly, a pre-parsing step has been introduced to the workflow.
Indeed, to completely remove the Action from this repository seemed to be the most straight-forward thing to do, hence this switch has also been implemented for the CI/CD - New updates to default branch workflow, which creates a temporary changelog with unreleased changes for the
latest
"version" in the documentation.Finally, the
--usernames-as-github-logins
option is added to the changelog generation, which is then appended to the release description, making all named contributions into GitHub handles (instead of markdown links). This will auto-add "contributors" on the GitHub page of the release.Markdown links are kept for other generated changelogs, since these are mainly shown in the documentation, which needs these named references to be full links.