diff options
| author | Nicholas Van Doorn <vandoorn.nick@gmail.com> | 2021-02-10 11:23:55 -0800 |
|---|---|---|
| committer | Nicholas Van Doorn <vandoorn.nick@gmail.com> | 2021-02-10 11:23:55 -0800 |
| commit | aa2ce499de5698f12a425ca81a2cb914e34fbfb7 (patch) | |
| tree | 59ba8225c83db456d57ca16e652d5d67c73504f1 | |
| parent | 6e9ff3c16c705cb75b55b4cfb9f66379bcad45a7 (diff) | |
Add information to README about versions in setup
When setting up this project and running specs, it's important to make
sure all versions are compatible. As such we make a note in the README
and provide the versions from the CI
Co-authored-by: Noah Silvera <noah@super.gd>
| -rw-r--r-- | README.md | 4 |
1 files changed, 3 insertions, 1 deletions
@@ -65,7 +65,9 @@ The extension provides currently two high level `calculator` classes that wrap t ## Development -After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. +Before installing dependencies, make sure your environment variables are setup. Our CI uses something like this: `SOLIDUS_BRANCH=v2.10 DB=postgresql RAILS_VERSION="~> 5.2.0`. These environment variables need to be set when installing dependencies and running specs, so set them before the command like this: `SOLIDUS_BRANCH=v2.10 DB=postgresql RAILS_VERSION="~> 5.2.0 bin/setup` + +Run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. To install this gem onto your local machine, run `bundle exec rake install`. 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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org). |