Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/packsaddle/ruby-github_status_notifier
https://github.com/packsaddle/ruby-github_status_notifier
Last synced: 7 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/packsaddle/ruby-github_status_notifier
- Owner: packsaddle
- License: mit
- Created: 2015-02-27T11:43:16.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2017-01-03T15:10:55.000Z (almost 8 years ago)
- Last Synced: 2024-07-29T11:06:43.758Z (4 months ago)
- Language: Ruby
- Homepage: http://packsaddle.org
- Size: 42 KB
- Stars: 7
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: changelog.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# GithubStatusNotifier
[](http://badge.fury.io/rb/github_status_notifier)
[](https://travis-ci.org/packsaddle/ruby-github_status_notifier)
## Usage
```
# before your command
$ github-status-notifier notify --state pending
$ SOME_YOUR_COMMAND
# after your command
$ github-status-notifier notify --exit-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](https://developer.github.com/v3/repos/statuses/)
## VS.
### [github-commit-status-updater](https://github.com/joker1007/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:
```ruby
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](https://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