Document the actual release process - #764
Merged
Merged
Conversation
CONTRIBUTING said to run rake release, which has not been how this gem ships since jwt#755 moved publishing to trusted publishing in push_gem.yml. Following the old instructions would push the gem from a maintainer's machine, bypassing the workflow that jwt#755 set up, and would also push the tag, which then triggers that workflow and fails it trying to publish a version already on RubyGems. Describe what actually happens instead: the version is already bumped on main by the previous release's next-iteration commit, the changelog gets dated on a branch and merged, and pushing the tag to upstream is the step that publishes. Also note the two things the old instructions left out, creating the GitHub release and opening the next iteration, and say plainly that rake release is not the way.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
CONTRIBUTING.mdstill told maintainers to runrake release, which has not been how this gem ships since #755 moved publishing to trusted publishing inpush_gem.yml.Following the old instructions would push the gem from a maintainer's machine, bypassing the workflow #755 set up, and would push the tag as well — which triggers that same workflow and fails it, trying to publish a version already on RubyGems.
The section now describes what actually happens:
JWT.gem_version, builds, pushes via trusted publishing and waits for propagation. No local credentials.rake releaseis called out explicitly, with the reason.It also covers the two steps the old instructions omitted: creating the GitHub release named
jwt-<version>with the changelog section as its body, and opening the next iteration.Written from the 3.3.0 release, which followed exactly these steps.