summaryrefslogtreecommitdiffstats
path: root/CLI/ruby/README.md
diff options
context:
space:
mode:
authora14m <[email protected]>2020-12-09 16:31:34 +0000
committera14m <[email protected]>2020-12-09 16:31:34 +0000
commit261cd75a0a2277e05ce66e2b53a23b5151e5775a (patch)
tree883476dc1796c0bfcd8ed32460972e5b142059c8 /CLI/ruby/README.md
parent457f78b6d27ebded45635bbf1be4c5af1bef531c (diff)
parentfbf4247ee72fe635cac87c3d44ca593671196cf3 (diff)
Merge branch 'feature/gem-release' into 'master'
Configure Gem releases See merge request a14m/game-of-life!4
Diffstat (limited to 'CLI/ruby/README.md')
-rw-r--r--CLI/ruby/README.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/CLI/ruby/README.md b/CLI/ruby/README.md
index 5207529..a44511a 100644
--- a/CLI/ruby/README.md
+++ b/CLI/ruby/README.md
@@ -51,6 +51,14 @@ Run `bundle exec rspec` or `bundle exec rake spec`
## Documentation
Run `bundle exec yard`
+## Release
+- Update the [version](./lib/game_of_live/version.rb) number
+- Update the [CHANGELOG](./CHANGELOG.md)
+- Create a git(lab) tag `ruby/v#{version_number}` ex: `ruby/v0.1.1-pre`
+
+The tag will automatically trigger the release workflow after successful build/test
+and release the changes to [rubygems.org](https://rubygems.org/gems/terminal_game_of_life)
+
## Extra information
### [Contributing](../../CONTRIBUTING.md)
### [License](../../LICENSE.md)