actions-marketplace-validations/ChatOps For Pull Requests
Listen for special comments, or chatops commands in the comments of a PR.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| APP_PEM | string version of your PEM file used to authenticate as a GitHub App | no | — |
| APP_ID | you GITHUB App ID. | no | — |
| TRIGGER_PHRASE | this is the phrase in a PR comment that you want to trigger downstream Actions. Example - "/deploy-app-test" | yes | — |
| INDICATOR_LABEL | label that will be added to the PR if a triggering comment is detected. This is used to trigger downstream Actions with the right context of the PR. | no | "" |
| TEST_EVENT_PATH | An alternate place to fetch the payload for testing and debugging when making changes to this Action. This is set to they system environment variable $GITHUB_EVENT_PATH by default. | — | "" |
Outputs
| name | description |
|---|---|
| TRAILING_LINE | the text that immediately follows the triggering phrase that is on the same line. For example, "/trigger-phrase foo bar\n next line" will emit the value "foo bar" This is intended to be used as arguments for downstream actions. |
| TRAILING_TOKEN | this is the next token that immediately follows the triggering phrase that is on the same line. For example, "/trigger-phrase foo bar" will emit the value "foo". This is intended to be used as arguments for downstream actions. |
| BOOL_TRIGGERED | true or false depending on if the trigger phrase was detected and this is a pull request. |
| PULL_REQUEST_NUMBER | the number of the pull request |
| COMMENTER_USERNAME | The GitHub username of the person that made the triggering comment in the PR. |
| BRANCH_NAME | The name of the branch corresponding to the PR. |
| SHA | The SHA of the branch on the PR at the time the triggering comment was made. |
| APP_INSTALLATION_TOKEN | The installation access token for the GitHub App corresponding to and the current repository. This is only retrieved if the `APP_PEM` and `APP_ID` inputs are supplied. |