chore(docs): Improve slack documentation

aevea · Feb 28, 2020 · d76dad7 · d76dad7
1 parent 828da3e
commit d76dad7
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -23,6 +23,7 @@ jobs:
         run: go run main.go publish
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          SLACK_WEBHOOK: ${{ secrets.SLACK_WEBHOOK }}
 
       # Temp blocker until issue in GH Action fixed
 #      - name: goreleaser

diff --git a/README.md b/README.md
@@ -19,6 +19,7 @@ Expected output is [HERE](./expected-output.md)
 1. [Setup](#setup)
    - [Github](#github)
    - [Gitlab](#gitlab)
+   - [Slack](#slack)
 2. [Usage](#usage)
 
 ## Setup
@@ -31,7 +32,6 @@ Expected output is [HERE](./expected-output.md)
 | ----------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------- |
 | GITHUB_TOKEN      | token (provided in Github Action or [HERE](https://help.github.com/en/articles/creating-a-personal-access-token-for-the-command-line)) | true     |
 | GITHUB_REPOSITORY | commitsar-app/commitsar                                                                                                                | true     |
-| SLACK_WEBHOOK     | https://hooks.slack.com/services/something/something/something                                                                         | false    |
 
 In Github actions GITHUB_REPOSITORY is provided in the correct format. Does not need to be explicitly added.
 
@@ -49,6 +49,13 @@ In Gitlab CI all the values are provided except for `GITLAB_TOKEN`. Documentatio
 | CI_API_V4_URL | https://gitlab.com/api/v4                                      | true     |
 | CI_COMMIT_TAG | v0.0.4                                                         | true     |
 | CI_PROJECT_ID | 1234                                                           | true     |
+
+### Slack
+
+Slack integration posts release notes into Slack using the `Incoming webhook` integration. [Slack Documentation](https://api.slack.com/messaging/webhooks)
+
+| Name          | Example value                                                  | Required |
+| ------------- | -------------------------------------------------------------- | -------- |
 | SLACK_WEBHOOK | https://hooks.slack.com/services/something/something/something | false    |
 
 ## Usage