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

Uploaded Source

Built Distribution

ghstatus-0.2.1-py2.py3-none-any.whl (6.1 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

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

File hashes

Hashes for ghstatus-0.2.1.tar.gz
Algorithm Hash digest
SHA256 f6285544131025713d6b8973ca230c981c1b6512f1de035bb00bfab5a1f34bda
MD5 04e86b33e74ca8387950241a75eef4e5
BLAKE2b-256 f27cdca0256a3b6e7b65542c8c6ce96b3be7bf75a8d29e1aca1243d3a919f4c8

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ghstatus-0.2.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 1cedaf6c40502051db6a5b28c137dfffb117bfbf5fda9e61f1f15eb1b8cd66eb
MD5 d526f6104af3b4d35c2975c9c0701852
BLAKE2b-256 7d5229d0620784119c1f6c2e040343d4a16d63b8055b5ea3730c57300e229c1b

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