commit-status

A simple CLI tool to post commit statuses to GitHub from CI.
Supports CircleCI, Travis CI, and Codeship.

About

At Taskworld, we want to have fine-grain status report for each commit.
This is a perfect use case for GitHub’s commit status API.

Usage

$3

commit-status will look for GitHub access from these environment variables, in this order:

- GH_STATUS_TOKEN
- GH_TOKEN

That token should have repo:status scope.

You can create a bot account and obtain a token at https://github.com/settings/tokens/new.

$3

If you use GitHub Enterprise, then you can override the API endpoint by GITHUB_API environment variable.

``sh
env GITHUB_API=https://[hostname]/api/v3 commit-message ...
`

CLI

$3

Inside your CI deps script, install commit-status there:

`
npm install -g commit-status
`

$3

Whenever you want to post a commit status from CI, invoke the command:

`
commit-status []
`

- state — Either pending, success, error, failure
- context — “A string label to differentiate this status from the status of other systems.”
- description — “A short description of the status.”
- url — The URL to display.

Example CircleCI setup:

`yaml
- |
if gulp lint
then commit-status success lint/eslint "Linting successful."
else commit-status failure lint/eslint "There are lint errors."
fi
`

API

`js
const commitStatus = require('commit-status')

commitStatus.post({
state: 'success',
context: 'lint/eslint',
description: 'Linting successful.'
})
``