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

Uploaded Source

Built Distribution

ghstatus-0.2.3-py2.py3-none-any.whl (7.8 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

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

File hashes

Hashes for ghstatus-0.2.3.tar.gz
Algorithm Hash digest
SHA256 95eac4aea7f76a3292ceefbe150494f16e5671a55c88b82d50cc45b438a831e9
MD5 692a0bcfa050b99912d7d8775adda7a9
BLAKE2b-256 190305c8e7efe93f905f21f72b62fd2a78245e39492f284c5201245685b05c15

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ghstatus-0.2.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 39eb2000140f465d900dcc883709373a8a061f01236bf6dce3e19b439c0059dd
MD5 2d27d7e7444b83fb8501e8af512c5e64
BLAKE2b-256 77aae4e56d4ea070db2997d74484a5c6aa16ebbbabfa40f06692809e3191aed7

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