Skip to main content

GitHub commit status updater

Project description

Build status MIT license PyPI package version PyPI python version

GitHub commit status notifier CLI

Options

These options can be automatically set from env variables or dotenv (.env) file in working dir.

  • -u: GITHUB_USERNAME

  • -p: GITHUB_PASSWORD

  • –base-url: GITHUB_URL

  • –repo: GITHUB_REPO

  • –sha: GITHUB_SHA

  • –target-url: TARGET_URL

These options can be set automatically in Jenkins context (JENKINS_URL is set).

  • –target-url: BUILD_URL

If not set by either CLI args or env variables, these options can be automatically detected from git repository in current working dir.

  • –repo: inferred from .git/config

  • –sha: inferred by executing git rev-parse HEAD internally

Sample commands

get all statuses

ghstatus get

set status

ghstatus set success --context=unit-test --description='All tests pass!' \
  --target-url=https://example.com/my-test/1

set status dynamically based on command exit code

ghstatus exec --context=unit-test -- ./gradlew test

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ghstatus-0.3.2.tar.gz (4.9 kB view details)

Uploaded Source

Built Distribution

ghstatus-0.3.2-py2.py3-none-any.whl (7.7 kB view details)

Uploaded Python 2Python 3

File details

Details for the file ghstatus-0.3.2.tar.gz.

File metadata

  • Download URL: ghstatus-0.3.2.tar.gz
  • Upload date:
  • Size: 4.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for ghstatus-0.3.2.tar.gz
Algorithm Hash digest
SHA256 abb966faa322940ac9bb977ca7349e766e49b02a4bf202aee6c079b3f60d01ec
MD5 1eaa7c1d3b4821d33e3d4503b91412e4
BLAKE2b-256 4b6867270f547c53a0866cb04f607c1e100393e4f9135566dac9df8ffa30782f

See more details on using hashes here.

File details

Details for the file ghstatus-0.3.2-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for ghstatus-0.3.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 a73c4bcc3c892230dacbc5f7ed8b7be8204c172bd59af1840fefbabf8c51cdd6
MD5 e9aff5e4cb2c780e57a4ad78889e5a21
BLAKE2b-256 a268320da5231ec1885af7dc8afae0a29d3859641314e3ead39006975a250c9d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page