# Workflow to Maintain This Gem

I use the gem-release gem

For more info see: https://github.com/svenfuchs/gem-release#usage


## Steps for an update

1. Update code and commit it.
2. Add entry to CHANGELOG and commit it
3. Bump the version with one of these commands:
   * `gem bump --version 1.1.1` # Bump the gem version to the given version number
   * `gem bump --version major` # 0.0.1 -> 1.0.0
   * `gem bump --version minor` # 0.0.1 -> 0.1.0
   * `gem bump --version patch` # 0.0.1 -> 0.0.2
4. Make sure there are no uncommitted changes! They will be pushed to rubygems.
5. Release it.
   * `gem release`
6. Create a git tag and push to origin.
   `gem tag`


## How to run specs

`bundle exec rake` in the filterrific repo


## How to support a new major Rails version

Follow these steps when starting support for a new Rails major version:

* In `filterrific`
   * Archive the current major rails version into a new branch off of master, e.g., when starting to support Rails 6, create a new branch for `5.x` from current master. This will be the branch used for ongoing 5.x support, and all new development for Rails 6 will happen in the `master` branch.
   * Make all changes required to support a new version of Rails.
   * Release the first `filterrific` version for Rails 6: `6.0.0`.

* In `filterrific_demo`
   * Following the same example for Rails 6:
   * Make sure that the `5.x` branch is up-to-date with master, and with current filterrific.
   * Create a new `6.x` branch. In that branch create a brand new rails app using a current version of Rails 6.
   * Make sure that the app works with the relevant version of `filterrific`.
   * Deploy demo app to heroku.


## Travis CI

Filterrific uses Travis CI for testing. We test filterrific code directly here
in the gem. We test Rails integration in the filterrific_demo app. There we have
a branch for each minor version of Rails that is tested and supported.

Sequence of a release:

* finish updates in filterrific
* update filterrific_demo Gemfile to refer to local filterrific via path: "../filterrific"
* start the app and exercise it (currently there are no automated tests)
* when everything works as expected, release filterrific (see above for steps)
* after new filterrific is released, add new release version to each branch in
  filterrific_demo.