Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

thbishop/github-commit-status

Open more actions menu

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

github-commit-status

Build Status

This is a simple utility to update the status of a commit on github. The primary use case is to update the status of a commit in a build environment.

Install

Download the latest binary or brew tap thbishop/github-commit-status && brew install github-commit-status if you're on OSX.

Usage

Create a github token with repo:status scope and export it as an env var:

export GITHUB_TOKEN=1234

Update the status with:

github-commit-status --user foo --repo bar --commit $SHA --state success

You can also optionally include a target url, description, or context to be included in the status update:

github-commit-status --user foo \
                     --repo bar \
                     --commit $SHA \
                     --state success --target-url https://ci.example.com/build/1 \
                     --description "It failed because it is busted" \
                     --context ci

If you're using github enterprise, you can set the API endpoint with an env var like so:

export GITHUB_API=https://github.example.com/api/v3

If needed, a proxy can be configured using environment variables:

  • http_proxy
  • HTTP_PROXY

Contribute

  • Fork the project
  • Make your feature addition or bug fix (with tests and docs) in a topic branch
  • Make sure tests pass
  • Send a pull request and I'll get it integrated

LICENSE

See LICENSE

About

cli to update a the status of a commit on github

Resources

License

Stars

Watchers

Forks

Packages

No packages published
Morty Proxy This is a proxified and sanitized view of the page, visit original site.