Saddler::Reporter::Github
Saddler reporter for GitHub.
Reporters
This provides saddler reporters for GitHub.
- PullRequestComment
--require saddler/reporter/github
--reporter Saddler::Reporter::Github::PullRequestComment
- PullRequestReviewComment
--require saddler/reporter/github
--reporter Saddler::Reporter::Github::PullRequestReviewComment
- CommitComment (under construction)
--require saddler/reporter/github
--reporter Saddler::Reporter::Github::CommitComment
- CommitReviewComment (under construction)
--require saddler/reporter/github
--reporter Saddler::Reporter::Github::CommitReviewComment
Usage
$ saddler report \
--require saddler/reporter/github \
--reporter Saddler::Reporter::Github::PullRequestReviewComment
like this. See Saddler.
Requirement
Set GITHUB_ACCESS_TOKEN=__your_access_token__
to your environment variable.
TravisCI
$ gem install travis
$ travis encrypt -r <owner_name>/<repos_name> "GITHUB_ACCESS_TOKEN=<github_token>"
CircleCI
Environment variables - CircleCI
API
For GitHub Enterprise
Put your api endpoint url into environment variable OCTOKIT_API_ENDPOINT
.
$ OCTOKIT_API_ENDPOINT='http://yourhostname.example.com/api/v3/' saddler report --require saddler/reporter/github --reporter ...
See: Using ENV variables
Changelog
Installation
Add this line to your application's Gemfile:
gem 'saddler-reporter-github'
And then execute:
$ bundle
Or install it yourself as:
$ gem install saddler-reporter-github
Development
After checking out the repo, run bin/setup
to install dependencies. Then, 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
to create a git tag for the version, push git commits and tags, and push the .gem
file to rubygems.org.
Contributing
- Fork it ( https://github.com/packsaddle/ruby-saddler-reporter-github/fork )
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create a new Pull Request
License
© sanemat
The gem is available as open source under the terms of the MIT License.