freckle/Notify Slack
Minimal inputs action to notify Slack of Job status
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| slack-webhook-url | Slack webhook url, typically a repository secret. | yes | — |
| slack-channel | Explicit channel for this notification. If omitted (the default), the channel configured in the webhook is used. | no | "" |
| event-name | A name for the event being notified about. If not given, the workflow and job id is used. | no | "" |
| message | Additional content to add to the message. Details about the commit that triggered the Job in which this step is run are always included. | no | "" |
| commit-sha | Commit SHA to fetch details for. Default is the PR head sha or github.sha if not in the context of a PR. | no | ${{ github.event.pull_request.head.sha || github.sha }} |
| slack-users | A JSON object (as a string in the Yaml) mapping GitHub usernames to Slack User Ids (e.g. UXXXXXX). If present, the commit author is looked up in the map and the Slack user, if found, is at-mentioned in the notification details. If a Slack user is not found, an error is generated as a build annotation. | no | "" |
| slack-users-file | Relative path within the repository to read the slack-users JSON from a file. The file is read from the default branch via the API. | no | "" |
| job-name | An explicit job-name, in cases where github.job (the job.id) won't work such as matrix jobs. | no | "" |
| job-status | An explicit job-status, in cases where the status of the current job is not the desired status to notify about. | no | "" |
| github-token | — | no | ${{ github.token }} |
| dry-run | Don't actually notify (useful for testing) | no | false |
Outputs
no outputs