Skip to content

Commit 749ca0c

Browse files
committed
docs: Add Slack notification documentation
1 parent ca84afe commit 749ca0c

File tree

2 files changed

+17
-0
lines changed

2 files changed

+17
-0
lines changed

docs/usage/notifications.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Notifications
2+
3+
Much of the functionality of StackHPC Release Train is built around GitHub Actions workflows.
4+
Some of these are triggered automatically based on an event such as pushing to a branch in a GitHub repository.
5+
Others are triggered manually, such as using a "workflow dispatch" from GitHub's web UI or API.
6+
7+
Failure of a manually triggered workflow will result in an email being sent to the user who triggered the workflow.
8+
Failure of an automatically triggered workflow will result in an email being sent to the user who *created* the workflow file.
9+
This is not ideal, and makes that person a bottleneck and single point of failure.
10+
To make failures of automatically triggered workflows more visible, notifications are sent to the `#release-train-alerts` Slack channel.
11+
12+
These notifications are implemented in the [slack-alert](https://github.com/stackhpc/stackhpc-release-train/tree/main/.github/actions/slack-alert/) GitHub action.
13+
The `slack-alert` action uses the "workflow builder" approach described in [slack-github-action](https://github.com/slackapi/slack-github-action/).
14+
Slack's [workflow builder](https://slack.com/intl/en-gb/help/articles/360035692513-Guide-to-Slack-Workflow-Builder) feature allows for flexible integration of Slack with various other services, based on various events.
15+
The [Release train status](https://slack.com/shortcuts/Ft07L987AQ91/1f20fd53512385abf199c9357071cb02) workflow has a webhook URL event trigger, with a single action that sends a message to the `#release-train-alerts` Slack channel.
16+
The Slack webhook URL is set in the `SLACK_WEBHOOK_URL` GitHub Actions secret, and the `#release-train-alerts` channel ID is set in the `SLACK_CHANNEL_ID` GitHub Actions variable.

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ nav:
2626
Access control: usage/access.md
2727
Source code CI: usage/source-code-ci.md
2828
GitHub Organisation Management: usage/github-organisation-management.md
29+
Notifications: usage/notifications.md
2930
- Operations:
3031
Ark: operations/ark.md
3132
Test Pulp: operations/test-pulp.md

0 commit comments

Comments
 (0)