Project

github_status_notifier

0.0
No commit activity in last 3 years
No release in over 3 years
github_status_notifierpacksaddle/ruby-github_status_notifierHomepageDocumentationSource CodeBug TrackerWiki
Easy to handle GitHub status with exit status. Like TravisCI's build status.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
58,106
Stars
7
Forks
0
Watchers
3
 Releases
Current version
1.0.0
Total releases
5
First release
2015-02-28
Latest release
2017-01-03
 Issues
Open Issues
2
Closed Issues
0
Total Issues
2
Issue Closure Rate
0%
 Pull Requests
Open Pull Requests
0
Closed Pull Requests
0
Merged Pull Requests
15
Pull Request Acceptance Rate
100%
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2015-06-06
Reverse Dependencies
0

 Dependencies

Development

bundler
>= 0
rake
>= 0
test-unit
>= 0

Runtime

saddler-reporter-github
>= 0
thor
>= 0
 Project Readme

GithubStatusNotifier

Gem Version Build Status

Usage

# before your command
$ github-status-notifier notify --state pending

$ SOME_YOUR_COMMAND

# after your command
$ github-status-notifier notify --exit-status $?

GitHub Status

Commands

Commands:
  github-status-notifier help [COMMAND]  # Describe available commands or one specific command
  github-status-notifier notify          # Notify current state to GitHub status
  github-status-notifier version         # Show the GithubStatusNotifier version

Usage:
  github-status-notifier notify

Options:
  [--exit-status=N]
  [--keep-exit-status], [--no-keep-exit-status]
  [--debug], [--no-debug]
  [--verbose], [--no-verbose]
  [--state=STATE]
                                                 # Possible values: pending, success, error, failure
  [--target-url=TARGET_URL]
  [--description=DESCRIPTION]
  [--context=CONTEXT]
                                                 # Default: github_status_notifier

Notify current state to GitHub status

see also: Statuses | GitHub API

VS.

github-commit-status-updater

Commands:
  github-commit-status-updater error -r, --repo=REPO -s, --sha1=SHA1    # commit status error
  github-commit-status-updater failure -r, --repo=REPO -s, --sha1=SHA1  # commit status failure
  github-commit-status-updater help [COMMAND]                           # Describe available commands or one specific command
  github-commit-status-updater pending -r, --repo=REPO -s, --sha1=SHA1  # commit status pending
  github-commit-status-updater success -r, --repo=REPO -s, --sha1=SHA1  # commit status success

github-commit-status-updater is very simple, but I want to detect repo and sha1 automatically.

Installation

Add this line to your application's Gemfile:

gem 'github_status_notifier'

And then execute:

$ bundle

Or install it yourself as:

$ gem install github_status_notifier

Setting

require setting GITHUB_ACCESS_TOKEN to your environment variable.

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. Run bundle exec github_status_notifier to use the code located in this directory, ignoring other installed copies of this gem.

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

  1. Fork it ( https://github.com/packsaddle/ruby-github_status_notifier/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request