Skip to content

Latest commit

 

History

History
55 lines (38 loc) · 1.58 KB

README.md

File metadata and controls

55 lines (38 loc) · 1.58 KB
Raw

PagerDuty Alert GitHub Action

Sends a critical PagerDuty alert, e.g. on action failure.

Prerequisites

  1. Create a service integration in PagerDuty:
    1. Go to PagerDuty > "Services" > Pick your service > "Integrations" > "Add a new integration"
    2. Choose a name (e.g. "Your GitHub CI/CD") and "Use our API directly" with "Events API v2"
    3. Copy the integration key
  2. Set up a secret in your GitHub repo to store the integration key, e.g. "PAGERDUTY_INTEGRATION_KEY"

Inputs

pagerduty-integration-key

Required: the integration key for your PagerDuty service

runbook-url

Required: the URL to a runbook to help triage the failure.

pagerduty-dedup-key

Optional: a dedup_key for your alert. This will enable PagerDuty to coalesce multiple alerts into one. More documentation is available here.

event-type

Optional: Can be used to resolve an alert when used together with pagerduty-dedup-key.

Example usage

In your steps:

Trigger a PagerDuty alert

- name: Send PagerDuty alert on failure
  if: ${{ failure() }}
  uses: Entle/[email protected]
  with:
    pagerduty-integration-key: '${{ secrets.PAGERDUTY_INTEGRATION_KEY }}'
    pagerduty-dedup-key: github_workflow_failed

Resolve a PagerDuty alert

- name: Resolve PagerDuty alert when CI succeeds
  uses: Entle/[email protected]
  with:
    pagerduty-integration-key: '${{ secrets.PAGERDUTY_INTEGRATION_KEY }}'
    pagerduty-dedup-key: github_workflow_failed
    event-type: resolve