ouzi-dev/commit-status-updater
A simple Github Action that allows us to update the status of the last commit in a pull request
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| token | Auth token used to add status commits. | yes | ${{ github.token }} |
| url | URL for the status check. | — | "" |
| description | Description for the status check. | — | "" |
| name | The context for the status. Default is GithubActions - ${GITHUB_WORKFLOW} | yes | GithubActions - ${{ github.workflow }} |
| status | Commit or job status, based on this the action will set the correct status in the commit: Accepted values are: 'error', 'failure', 'pending', 'success' and 'cancelled'. By default it will use the current job status. If the passed status is 'pending' it will set status commit 'pending' If the passed status is 'failure' or 'cancelled' it wil set status commit 'failure' If the passed status is 'success' it will set status commit 'success' If the passed status is 'error' it will set status commit 'error' | yes | pending |
| ignoreForks | If the pull request is from a fork the action won't add a status by default. This is because the action won't have a token with permissions to add the status to the commit. You can disable this, but then you'll have to provide a token with enough permissions to add status to the commits in the forks! Will be used only for pull requests. | yes | true |
| addHoldComment | If true the action will add a comment to the pull request. This is useful if you use prow and you get PRs from forks, you can use `/hold` and `/hold cancel` instead of the status check since the token won't have permissions to do that. Will be used only for pull requests. | — | false |
| pendingComment | This is the message to add to the pull request when the status is pending. Will be used only for pull requests. | — | /hold |
| successComment | This is the message to add to the pull request when the status is success. Will be used only for pull requests. | — | /hold cancel |
| failComment | This is the message to add to the pull request when the status is 'failure', 'error' or 'cancelled'. Will be used only for pull requests. | — | /hold |
Outputs
no outputs