CI status watch #2091
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,87 @@ | ||||||
| name: CI status watch | ||||||
|
|
||||||
| # Posts a Teams message listing the README badge workflows that are currently red on the | ||||||
| # default branch. A workflow stays in the list until it is green again, so the reminder | ||||||
| # repeats every weekday morning until somebody fixes it. Creates no issues, read-only. | ||||||
| # Requires the repository secret TEAMS_WEBHOOK_URL. | ||||||
|
|
||||||
| on: | ||||||
| workflow_dispatch: | ||||||
| schedule: | ||||||
| - cron: '0 7 * * 1-5' # 07:00 UTC, Mon-Fri (= 09:00 CEST / 08:00 CET) | ||||||
|
|
||||||
| permissions: | ||||||
| actions: read | ||||||
|
|
||||||
| jobs: | ||||||
| watch: | ||||||
| runs-on: ubuntu-latest | ||||||
| env: | ||||||
| GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||||||
| WEBHOOK: ${{ secrets.TEAMS_WEBHOOK_URL }} | ||||||
| REPO: ${{ github.repository }} | ||||||
| BRANCH: ${{ github.ref_name }} | ||||||
| steps: | ||||||
| - name: Detect newly red badge workflows and notify Teams | ||||||
| run: | | ||||||
| set -euo pipefail | ||||||
|
|
||||||
| # The workflows backing the README badges. Add a line here if a badge is added. | ||||||
| WORKFLOWS=" | ||||||
| .github/workflows/build.yml | ||||||
| .github/workflows/update-urls.yml | ||||||
| .github/workflows/nightly-build.yml | ||||||
| .github/workflows/integration-tests.yml | ||||||
| " | ||||||
|
|
||||||
| echo "Checking badge workflows on branch $BRANCH" | ||||||
|
|
||||||
| # A workflow counts as red if its newest completed run that produced a real result | ||||||
| # failed; cancelled/skipped runs say nothing about the code and are ignored. This is | ||||||
| # exactly what the README badge shows. There is no look-back window on purpose: as | ||||||
| # long as it stays red it is reported every morning, so nobody can miss it. | ||||||
| RED=$(for WF_PATH in $WORKFLOWS; do | ||||||
| gh run list --repo "$REPO" --workflow "$WF_PATH" --branch "$BRANCH" \ | ||||||
| --status completed --limit 5 --json conclusion,url,updatedAt,workflowName \ | ||||||
|
Member
There was a problem hiding this comment. you increased the limit from 2 to 5. However, we only take the first result
Suggested change
Contributor
There was a problem hiding this comment. The Real streaks on It is also free: That it reads the other way means the line needs a comment. A suggestion in this thread would only replace this line, so I put it on the comment block above (lines 39 to 42) as a separate comment. |
||||||
| --jq '[ .[] | select(.conclusion != "cancelled" and .conclusion != "skipped") ][0] | ||||||
| | select(. != null) | ||||||
| | select(.conclusion == "failure" or .conclusion == "timed_out" or .conclusion == "startup_failure") | ||||||
| | {name: .workflowName, url: .url, since: .updatedAt}' || true | ||||||
| done | jq -s '.') | ||||||
|
|
||||||
| COUNT=$(echo "$RED" | jq 'length') | ||||||
| if [ "$COUNT" -eq 0 ]; then | ||||||
| echo "No badge workflow is red. Skipping Teams notification." | ||||||
| exit 0 | ||||||
| fi | ||||||
| echo "$COUNT badge workflow(s) currently red." | ||||||
|
|
||||||
| if [ -z "${WEBHOOK:-}" ]; then | ||||||
| echo "No Teams webhook set, skipping notification."; exit 0 | ||||||
| fi | ||||||
|
|
||||||
| CARD=$(echo "$RED" | jq --argjson count "$COUNT" '{ | ||||||
| type: "AdaptiveCard", | ||||||
| "$schema": "http://adaptivecards.io/schemas/adaptive-card.json", | ||||||
| version: "1.4", | ||||||
| body: ( | ||||||
| [ | ||||||
| { type: "TextBlock", size: "Large", weight: "Bolder", wrap: true, color: "attention", | ||||||
| text: "🔴 CI ist rot" }, | ||||||
| { type: "TextBlock", spacing: "None", isSubtle: true, wrap: true, | ||||||
| text: (if $count == 1 then "1 Workflow ist rot" else "\($count) Workflows sind rot" end) } | ||||||
| ] | ||||||
| + [ .[] | { | ||||||
| type: "Container", | ||||||
| separator: true, | ||||||
| spacing: "Medium", | ||||||
| items: [ | ||||||
| { type: "TextBlock", weight: "Bolder", wrap: true, text: "🔴 \(.name)" }, | ||||||
| { type: "TextBlock", spacing: "None", isSubtle: true, size: "Small", wrap: true, | ||||||
| text: "rot seit \(.since) · [Run-Log öffnen](\(.url))" } | ||||||
| ] | ||||||
| } ] | ||||||
| ) | ||||||
| }') | ||||||
|
|
||||||
| curl -sS --fail -X POST -H "Content-Type: application/json" -d "$CARD" "$WEBHOOK" | ||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Follow-up to the
--limitthread: documenting why the limit is what it is, so the next reader does not read it as dead weight either.