refactor(ci): change the way releases are automated #122
Conversation
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
A lot of users will get Steward PRs that automatically link to the release page of that release. For example with the last release here this linked to https://github.com/com-lihaoyi/requests-scala/releases/tag/0.8.0. The thing is, this page is empty and doesn't tell the user anything. I know it's common in the com-lihaoyi ecosystem to include the changelog in the readme, so maybe we can also automate the release better. This pr changes a couple things: - Changes the actual github action in control of the release. The one we were using before (https://github.com/actions/create-release) is archived and no longer maintained. This switches to a new one that from what I can tell is the most popular (https://github.com/softprops/action-gh-release). - Use the `generate_release_notes` option which will automate generating the release notes by just putting all the commits for this release in there. - Use `append_body` to also then link to the changelog in the readme. This should be a nicer experience for those clicking the link with Steward without changing the way you currently manually do your changelog.
lefou reviewed Jan 3, 2023
Contributor Author
| Just for good measure I also added in the |
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.
A lot of users will get Steward PRs that automatically link to the
release page of that release. For example with the last release here
this linked to
https://github.com/com-lihaoyi/requests-scala/releases/tag/0.8.0. The
thing is, this page is empty and doesn't tell the user anything. I know
it's common in the com-lihaoyi ecosystem to include the changelog in the
readme, so maybe we can also automate the release better. This pr
changes a couple things:
were using before (https://github.com/actions/create-release) is
archived and no longer maintained. This switches to a new one that
from what I can tell is the most popular
(https://github.com/softprops/action-gh-release).
generate_release_notesoption which will automate generatingthe release notes by just putting all the commits for this release in
there.
append_bodyto also then link to the changelog in the readme.This should be a nicer experience for those clicking the link with
Steward without changing the way you currently manually do your
changelog.