Skip to content

Commit

Permalink
Merge pull request #32 from collectiveidea/update-readme-with-new-rel…
Browse files Browse the repository at this point in the history
…ease-instructions

Update README.md with new release instructions.
  • Loading branch information
darronschall authored May 22, 2024
2 parents 01e6ff1 + 8ab3778 commit 9e48369
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,20 @@ protoc --ruby_out=. --twirp_ruby_out=. ./example/hello_world.proto
## Releasing
To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
To release a new version:
* Submit a PR with the following changes (see [#30](https://github.com/collectiveidea/protoc-gen-twirp_ruby/pull/30)):
* Update the version number in `version.rb`
* Update the CHANGELOG.md
* Create a section for the new version and move the unreleased version there
* Re-generate the example:
* `protoc --plugin=protoc-gen-twirp_ruby=./exe/protoc-gen-twirp_ruby --ruby_out=. --twirp_ruby_out=. ./example/hello_world.proto`
* Once merged, run the release task from main. Note that we prepend `gem_push=no` to avoid
pushing to RubyGems directly; our GitHub publish action will do this for us.
* `gem_push=no bundle exec rake release`
* Create a GitHub release:
* `gh release create v<version>`
* Edit the release notes to link to the notes in the CHANGELOG.md for the version
## Contributing
Expand Down

0 comments on commit 9e48369

Please sign in to comment.