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

Uploaded Source

Built Distribution

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

Uploaded Python 2Python 3

File details

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

File metadata

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

File hashes

Hashes for ghstatus-0.3.0.tar.gz
Algorithm Hash digest
SHA256 68eddd14dec236515b33c529e0d5b556dedbf26931689ecd99579ddec7a60eac
MD5 9b592cd4b92df8f4cb93177e203dd076
BLAKE2b-256 21941104d16a271c1cf8daec5307c0ed3c2ade5f853871588bc1f90082bd4bd0

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ghstatus-0.3.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 b1d0cdad60e7c0e29e1d82b07624c205146f633a735866f44ad54aa4252480c8
MD5 183a31052dca5a77c283eaa15ca09db9
BLAKE2b-256 8dd0b4b095253a70784217f9f8be5b1044b821c6137f89d69be10c3f51cf496e

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