Quick-Start

Dependencies

Make sure the dependencies are installed.

• Ruby (Gitomator is developed and tested on version 2.2)
• Ruby Gems
• Bundler

Installation

gem install gitomator

Configure Credentials

Create a YAML configuration file called .gitomator in your home directory.

hosting:
  provider: github
  access_token: YOUR-GITHUB-ACCESS-TOKEN
  organization: YOUR-GITHUB-ORGANIZATION
  default_protocol: ssh  # This line is optional
  

ci:
  provider: travis_pro
  access_token: YOUR-TRAVIS-CI-ACCESS-TOKEN
  github_organization: YOUR-GITHUB-ORGANIZATION

• You can read more about how to create an access token on GitHub.
• If you don’t use Travis CI, feel free to omit the ci configuration
• The hosting’s default_protocol can be either https or ssh.
  If it is not specified, then https will be the default protocol.
• You can specify a different path (other than ~/.gitomator) for your configuration file, by setting the GITOMATOR_CONTEXT environment variable.
• Important: Keep your credentials safe!
  The .gitomator file is local to your machine, and should not be committed to version control.