Skip to content

Commit 41f672c

Browse files
author
marwan37
committed
update README with info about discord alerter and GH action
1 parent 7b07763 commit 41f672c

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,21 @@ The extension runs in two places:
7272
- Edit `tutorialMetadata.json`
7373
- Each section has steps with optional `doc` (markdown) and `code` (Python) files
7474

75+
### 🔔 Automated Pipeline Health Checks
76+
77+
This repo has a GitHub Actions workflow ([`.github/workflows/test-pipelines.yml`](.github/workflows/test-pipelines.yml)) that keeps our example pipelines green against the **latest ZenML release**:
78+
79+
| What it does | Process |
80+
| ---------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
81+
| **Runs every 24 h at 09:00 UTC** (plus on every push / PR to `main` and `develop`) | Cron trigger: `0 9 * * *` |
82+
| **Executes all tutorial pipelines** listed in the matrix | Each pipeline is run inside a fresh runner with ZenML upgraded to the newest version. |
83+
| **Alerts our SREs on Discord ** if any pipeline fails | On failure the job posts an alert to **`#sre-alerts`** via `DISCORD_WEBHOOK_SRE`. |
84+
85+
> The following repo secrets are set for the discord alerter:
86+
> `DISCORD_TOKEN_SRE`, `DISCORD_SRE_CHANNEL_ID`, and `DISCORD_WEBHOOK_SRE`.
87+
88+
Keeping an eye on this channel lets us catch breaking changes in ZenML or our tutorial code before users do.
89+
7590
## 🐳 Docker Image
7691

7792
The user-facing repository uses a pre-built Docker image for faster startup.

0 commit comments

Comments
 (0)