pronto-circleci
This gem allows to simply setup pronto along with circleci and github.
Installation
Application setup
Add the gem to your application's Gemfile:
gem 'pronto-circleci'
And then add the pronto runners of your choice (e.g. pronto-rubocop
)
gem 'pronto-rubocop'
After that update your bundle:
$ bundle
CircleCI setup
Setup circle to run pronto before your tests adding this to your circle.yml
test:
pre:
- bundle exec pronto-circleci
And finally setup an environment variable with a Github access token in the circleci environment configuration of your repo with the name of: PRONTO_GITHUB_ACCESS_TOKEN
.
Usage
Place a pronto-circleci.yml
under the config
folder of your app:
github:
org: 'comparaonline'
repo: 'pronto-circleci'
pronto:
comments_on_diff: true
reviews_on_diff: true
report_status: true
Config
The config flags under the pronto key map to the regular pronto configuration flags:
comments_on_diff
: Comments appear on pull request diff.
reviews_on_diff
: Review appear on pull request diff.
report_status
: Report status check on pull request.
Please note that these are optional and disabled by default.
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.
Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/pronto-circleci.
License
The gem is available as open source under the terms of the MIT License.