Satorix::Common

By Internet Exposure

build coverage

This gem contains code shared between two or more separate Satorix applications.

Installation

Add this line to your application's Gemfile:

gem 'satorix-common'

And then execute:

$ bundle

Or install it yourself as:

$ gem install satorix-common

Usage

Include the gem in a relevant project to access shared logic.

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.

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.

CI/CD

Satorix is used to provide continuous integration and continuous deployment for this application.

CI is run against every push.

CD is used to automatically build and deploy the gem for the master branch. To initiate the deploy, first ensure you have advanced the version number appropriately. Then, create a new version tag on the master branch. The tag should follow the format of v# (If we were releasing version 1.0.3, the tag should be v1.0.3).

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/satorix-common.