From d76dad7f3dc44a065e538c96fd1e81f4463029f1 Mon Sep 17 00:00:00 2001 From: Simon Prochazka Date: Fri, 28 Feb 2020 10:13:29 +0100 Subject: [PATCH] chore(docs): Improve slack documentation --- .github/workflows/release.yml | 1 + README.md | 9 ++++++++- 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index e97d7b4..533a66e 100644 --- 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 index cce2e88..cc8a0b4 100644 --- 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