summaryrefslogtreecommitdiffstats
path: root/CLI/ruby/README.md
diff options
context:
space:
mode:
authorAhmed AbdelHalim <[email protected]>2023-07-02 19:19:17 +0200
committerAhmed AbdelHalim <[email protected]>2023-07-02 19:19:17 +0200
commit36c22fba73375f18ad46334a27d6b418309448e8 (patch)
tree7017a6d74c7d0e5cb218a88072062ff91f7766f8 /CLI/ruby/README.md
parent58fefe99f933343f7c5556ca3bc719743c54f322 (diff)
Use docker for ruby dev and fix yard with ruby 3
Diffstat (limited to 'CLI/ruby/README.md')
-rw-r--r--CLI/ruby/README.md20
1 files changed, 13 insertions, 7 deletions
diff --git a/CLI/ruby/README.md b/CLI/ruby/README.md
index 88dafcd..9ca42d3 100644
--- a/CLI/ruby/README.md
+++ b/CLI/ruby/README.md
@@ -41,25 +41,31 @@ Options:
## Development
+### Locally
- Clone the repo.
- Navigate to the ruby CLI implementation `cd game-of-life/CLI/ruby`.
- run `bundle install` to install dependencies.
-- you can run `bundle rake build` to build the gem/CLI into the `pkg` directory.
-- you can run `bundle rake install` to build and install gem/CLI into system gems.
+- you can run `bundle exec rake build` to build the gem/CLI into the `pkg` directory.
+- you can run `bundle exec rake install` to build and install gem/CLI into system gems.
- you can run `bundle exec ./bin/game-of-life` to run the code for development/testing purposes
+### Docker
+- Run `docker build . -t ruby-gol`
+- Run `docker run -it -v .:/app ruby-gol bundle exec rake install`
+- Run `docker run -it ruby-gol`
+
## Linting
-Run `bundle exec rubocop`
+Run `bundle exec rubocop` or `docker run -it -v .:/app ruby-gol bundle exec rubocop`
## Testing
-Run `bundle exec rspec`
+Run `bundle exec rspec` or `docker run -it ruby-gol bundle exec rspec`
## Documentation
-Run `bundle exec yard`
+Run `bundle exec yard` or `docker run -it -v .:/app ruby-gol bundle exec yard`
## Release
-- Update the [version](./lib/game_of_live/version.rb) number
-- Run `bundle install` and commit changes
+- Update the [version](./game_of_life.gemspec#L5) number
+- Run `bundle install` and commit changes (or `docker run -it -v .:/app ruby-gol bundle install`)
- Update the [CHANGELOG](./CHANGELOG.md)
- Create a git tag `ruby/v#{version_number}` ex: `ruby/v0.1.1-pre`