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.1.tar.gz (4.8 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 2Python 3

File details

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

File metadata

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

File hashes

Hashes for ghstatus-0.3.1.tar.gz
Algorithm Hash digest
SHA256 adeaa10d44deb41f3f7cef8c09564db0f6aab69b76fad3e43e206d9b31dde56c
MD5 756a06b008e9ca9d06c3acc98234f95b
BLAKE2b-256 fc8c292bd6caaf7842c52f022fe9e9ca1851e0048ce1b34166603f439a682fba

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ghstatus-0.3.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 dc7f9bae0e5075c0c5373fa71fd123df5264d34d5cd51429e6efbca552dd4ce2
MD5 19c6c484501785a83011ae2fa5270029
BLAKE2b-256 2208e30c389a6b24c10b4bbdfa890cb887a729e71f6535a146a376202086a561

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