Streamline gem release with bundler gem task release override #41
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
This will convert a string into an URL HREF anchor. Specifically, we anticipate using this for headings in GitHub markdown files to construct links to those headings.
Requires installing the `gh` CLI. Gets the latest release from GitHub and outputs the version to STDOUT.
darronschall
force-pushed
the
streamline-release-task
branch
from
0e44c45 to
613a021
Compare
Leverages the `gh` CLI to create a release. This uses the same command that we specified in the README for releasing, but programmatically determines the version to specify and automatically crafts the proper release notes (linking to the CHANGELOG and the diff view).
We don't want the `release:rubygem_push` task to execute at all. Previously we used `gem_push=no bundle exec rake release` for this.. but since we're customize `release` to _also_ create a GitHub release, let's just remove the RubyGem push to it will never accidentally trigger if someone forgets the `gem_push=no` ENV var.
Our `rake release` task override does everything we need for release now. There are no more manual steps.
darronschall
force-pushed
the
streamline-release-task
branch
from
613a021 to
7ed83a3
Compare
danielmorrison
approved these changes
May 29, 2024
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.
Override default gem
releasetask with our own to customize behavior to make releasing as simple and straightforward as possible.We don't want the
release:rubygem_pushtask to execute at all, even accidentally, since #31 publishes the gem automatically with GitHub as a trusted publisher. (Previously we usedgem_push=no bundle exec rake releaseto release without the gem push, but that's easy to forget).Since we're overriding
release, we also use it to automate creating a GitHub release. No more having to manually run the command and edit release notes, etc.