https://github.com/ynab/slack-post-message-action
GitHub Action that posts a message to a Slack channel
https://github.com/ynab/slack-post-message-action
Last synced: 5 months ago
JSON representation
GitHub Action that posts a message to a Slack channel
- Host: GitHub
- URL: https://github.com/ynab/slack-post-message-action
- Owner: ynab
- License: mit
- Created: 2023-01-25T20:09:06.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-01-07T20:26:32.000Z (6 months ago)
- Last Synced: 2025-02-08T01:47:43.261Z (5 months ago)
- Size: 24.4 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Slack Post GitHub Action
GitHub Action that posts a message to a Slack channel
## Inputs
### `token`
**Optional** The Slack auth token. This is only required if environment variable `SLACK_BOT_TOKEN` is not set.
### `channel`
**Required** The channel name to post to (example: `#general`)
### `thread_ts`
**Optional** The timestamp ID of the parent message to reply to (e.g., the `ts` output from a previous Slack message call)
### `text`
**Required** The message text to post. See [Slack's documentation on formatting](https://api.slack.com/reference/surfaces/formatting#basic-formatting).
Notes:
- single quotes in your message *must* be escaped as `\'` due to how this input is consumed by bash (example: `text: "This is a \'single quote\' test"`)
- environment variables will only be expanded if referenced using the `env` GitHub Action context `${{ env.MY_VAR }}` format (example: `text: "This is the value of MY_VAR: ${{ env.MY_VAR }}"`)
### `unfurl_links`
**Optional** Whether links in the message should be unfurled (default: `true`)
## Outputs
### `ts`
The timestamp ID of the message (can be used to make subsequent Slack messages a threaded reply)
## Example usage
```yaml
- name: Post Slack message
uses: ynab/[email protected]
with:
token: ${{ secrets.SLACK_API_TOKEN }}
channel: "#general"
text: ":tada: This is a test from the ${{ env.GITHUB_ACTION }} workflow! "
```