Skip to content

Commit 54166f8

Browse files
committed
docs: add readme
1 parent 10ec517 commit 54166f8

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# commit-status-poster
2+
Posts a GitHub Commit Status using a GitHub App to a given reference
3+
4+
## Running
5+
Requires the following environment variables:
6+
* `GITHUB_APP_ID`
7+
* `GITHUB_APP_INSTALLATION_ID`
8+
* `GITHUB_APP_PRIVATE_KEY_FILE`: Path pointing to a file containing the private key.
9+
* `GITHUB_COMMIT_STATUS_STATE`: One of `error`, `failure`, `pending`, `success`.
10+
* `GITHUB_COMMIT_STATUS_TARGET_URL`: URL for the "Details" link appearing next to the status.
11+
* `GITHUB_COMMIT_STATUS_DESCRIPTION`: Description describing the current status, e.g. "Deploying..."
12+
* `GITHUB_COMMIT_STATUS_CONTEXT`: The name that appears on GitHub. Must be the same when updating an
13+
existing status.
14+
* `GITHUB_OWNER`
15+
* `GITHUB_REPO`
16+
* `GITHUB_REF`: The commit hash the status applies to.

0 commit comments

Comments
 (0)