diff --git a/README.md b/README.md index c074760..38f3fed 100644 --- a/README.md +++ b/README.md @@ -5,8 +5,19 @@ Send data into Slack using this GitHub Action! This package has two different te 1) Send data to Slack's Workflow Builder (requires a paid Slack instance). 2) Send data via a Slack app to post to a specific channel (use an existing custom app or create a new one). +The recommended way to use this action is with Slack's Workflow Builder (if your on a paid Slack plan). + ## Slack Workflow Builder Route +Sending data to [Slack's Workflow builder](https://slack.com/intl/en-ca/features/workflow-automation) is the recommended way to use this action. This action will flatten and stringify the json payload from GitHub and send it over to a Slack Workflow webhook URL. Follow [these steps to create a Slack workflow using webhooks](https://slack.com/intl/en-ca/help/articles/360041352714-Create-more-advanced-workflows-using-webhooks). The Slack workflow webhook url will be in the form of `https://hooks.slack.com/workflows/....`. Add this workflow + +### Setup + +* [Create a Slack workflow webhook](https://slack.com/intl/en-ca/help/articles/360041352714-Create-more-advanced-workflows-using-webhooks) +* Copy the webhook URL (`https://hooks.slack.com/workflows/....`) and [add it as a secret in your repo settings](https://docs.github.com/en/free-pro-team@latest/actions/reference/encrypted-secrets#creating-encrypted-secrets-for-a-repository) named `SLACK_WEBHOOK_URL`. +* Add a step to your GitHub action to send data to your Webhook +* Configure your Slack workflow to use variables from the incoming payload from the GitHub Action. You can select where you want to post the data and how you want to format it in Slack's worflow builder interface. + ### Usage ``` @@ -30,4 +41,12 @@ Send data into Slack using this GitHub Action! This package has two different te slack-message: 'posting from a github action!' env: SLACK_BOT_TOKEN: ${{ secrets.SLACK_BOT_TOKEN }} -``` \ No newline at end of file +``` + +## Contributing + +See [CONTRIBUTING](.github/contributing.md). + +## License + +See [LICENSNE](LICENSE). \ No newline at end of file