← Recipes

阅读中文版本

Notify On-Call on Pipeline Failure with Context

Send a structured notification with the failing job, logs link, and last commit when a critical pipeline fails.

~15 mincialertsnotifications

Task

Automate gh run view $RUN_ID --log-failed | curl -X POST $WEBHOOK -d @- so pipeline failures are caught before merge and never reach production.

When to use this

A pull request merges with a broken gh run view $RUN_ID --log-failed | curl -X POST $WEBHOOK -d @- step because the workflow did not gate on it, causing a failed deploy.

Prerequisites

  • Node.js 22 and pnpm available
  • A CI workflow file in .github/workflows

Steps

1. Configure gh run view $RUN_ID --log-failed | curl -X POST $WEBHOOK -d @- in the project configuration file with the recommended defaults.

gh run view $RUN_ID --log-failed | curl -X POST $WEBHOOK -d @-

Expected output: The configuration is accepted and gh run view $RUN_ID --log-failed | curl -X POST $WEBHOOK -d @- runs without errors on the first invocation.

2. Run the check locally to verify gh run view $RUN_ID --log-failed | curl -X POST $WEBHOOK -d @- produces the expected result before pushing.

pnpm test

Expected output: Local run matches CI behavior; no surprises after push.

3. Add the gate to the CI pipeline so gh run view $RUN_ID --log-failed | curl -X POST $WEBHOOK -d @- blocks merge on failure.

- name: Run add pipeline failure notification
  run: pnpm test

Expected output: Pull requests with failing gh run view $RUN_ID --log-failed | curl -X POST $WEBHOOK -d @- are blocked from merging.

Troubleshooting

Problem

The check passes locally but fails in CI

Solution

Pin dependency versions and the runtime to match CI exactly; reproduce with the same Docker image or act.

Problem

Configuration is rejected with a schema error

Solution

Check the tool version matches the config schema; older versions may not support newer fields.

Limitations

  • The gate only runs on events that trigger the workflow; locally pushed commits bypass it.
  • Configuration drift is possible if someone edits settings outside version control.

Gate the pipeline before merge

Start by measuring the problem. Send a structured notification with the failing job, logs link, and last commit when a critical pipeline fails. The most common mistake is adding the gate without first confirming it catches the issue you care about. Run gh run view $RUN_ID –log-failed | curl -X POST $WEBHOOK -d @- against the current codebase and inspect the output before wiring it into CI.

gh run view $RUN_ID --log-failed | curl -X POST $WEBHOOK -d @-

Make failures actionable

Once the gate is in place, make failures actionable. A failing gh run view $RUN_ID –log-failed | curl -X POST $WEBHOOK -d @- should point to the exact file and line, not a generic error. Pin the tool version in the lockfile so a upstream release does not silently change behavior. Review the gate output in every pull request just like a test result.