github
/
twirp-ruby
зеркало из https://github.com/arthurnn/twirp-ruby.git
1
0
Форкнуть 0
Код Задачи Пакеты Проекты Релизы Вики Активность

Update contributing guide

This commit is contained in:
Arthur Nogueira Neves 2023-01-05 09:01:56 -05:00
Родитель dc84e0d293
Коммит d7edd89e52
1 изменённых файлов: 6 добавлений и 5 удалений
Показать статистику Скачать Patch файл Скачать Diff файл Показать все файлы Свернуть все файлы

11
CONTRIBUTING.md
Просмотреть файл

@ -15,14 +15,15 @@ Features and bugfixes are managed through Github's Issues and Pull Requests. Con
Once enough new features are added, a new release is drafted.
* Merge approved PRs into master.
* Merge approved PRs into main.
* Update VERSION with semantic versioning in:
* `lib/twirp/version.rb` and
* `protoc-gen-twirp_ruby/version.go`
* Run `bundle install` to update the `Gemfile.lock` file with the new version.
* Run `rake` to run tests.
* Re-generate code (see [example/README.md](example/README.md)). Make sure to use the latest version of `protoc-gen-twirp_ruby`; if the repo is in `$GOPATH/src/github.com/twitchtv/twirp-ruby`, then you only need to do `go install github.com/twitchtv/twirp-ruby/protoc-gen-twirp_ruby` before running the `protoc` command to generate code. The generated code should be annotated with the new version.
* Re-generate code (see [example/README.md](example/README.md)). Make sure to use the latest version of `protoc-gen-twirp_ruby`; if the repo is in `$GOPATH/src/github.com/github/twirp-ruby`, then you only need to do `go install github.com/github/twirp-ruby/protoc-gen-twirp_ruby` before running the `protoc` command to generate code. The generated code should be annotated with the new version.
* Update example code and README if needed with new features.
* Commit changes for the new version in master and push to remote.
* [Draft a new release](https://github.com/twitchtv/twirp-ruby/releases) in Github. Create a new tag with the version. Add release notes (see previous releases to keep the same format).
* Build the gem: `gem build twirp.gemspec` and then push the new .gem file to Ruby Gems: `gem push twirp-X.X.X.gem`. You can delete the .gem file after that.
* Commit changes for the new version in main and push to remote.
* [Draft a new release](https://github.com/github/twirp-ruby/releases) in Github. Create a new tag with the version. Add release notes (see previous releases to keep the same format).
* Build and push the gem: `rake release`.
* Update the Draft release with the created tag, and publish it.