adam
/
slack-webhook-orb
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Add setup and usage instructions to README

This commit is contained in:
Adam Millerchip 2020-10-17 22:51:34 +09:00 committed by GitHub
parent 100606366b
commit 163f9499c8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 29 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
README.md
View File

@ -2,9 +2,36 @@
## Setup
## Usage Examples
1. [Create a webhook](https://api.slack.com/messaging/webhooks).
2. [Generate a JSON payload](https://app.slack.com/block-kit-builder).
3. Place the webhook in a [CircleCI environment variable](https://circleci.com/docs/2.0/env-vars/) (`SLACK_WEBHOOK` by default, but customizable).
4. Call the orb:
```yml
slack-webhook/send-message:
json-payload: |
{
"blocks": [
{
"type": "section",
"text": {
"type": "mrkdwn",
"text": "Hello from <https://github.com/adamu|@adamu>'s `slack-webhook` CircleCi orb! 👋"
}
}
]
}
```
See the usage examples on the orb's [CircleCI Orb Repository listing](https://circleci.com/developer/orbs/orb/adamu/slack-webhook#usage-examples).
## Usage
The `json-payload` argument must always be provided.
There are three ways to provide the webhook URL:
1. Via the `SLACK_WEBHOOK` environment variable.
2. Via a custom environment variable. Provide the name with the `webhook-url-env-var` parameter.
3. Directly to the webhook with the `json-payload` parameter.
See the full examples on the orb's [CircleCI Orb Repository listing](https://circleci.com/developer/orbs/orb/adamu/slack-webhook#usage-examples).
## Changelog