You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
GitHub Action
PagerDuty Alert Remastered
0.3.0
Pre-release
Sends a critical PagerDuty alert, e.g. on action failure.
- Create a service integration in PagerDuty:
- Go to PagerDuty > "Services" > Pick your service > "Integrations" > "Add a new integration"
- Choose a name (e.g. "Your GitHub CI/CD") and "Use our API directly" with "Events API v2"
- Copy the integration key
- Set up a secret in your GitHub repo to store the integration key, e.g. "PAGERDUTY_INTEGRATION_KEY"
pagerduty-integration-key
Required: the integration key for your PagerDuty service
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.
incident-summary
Optional: a custom summary for your PagerDuty alert
incident-region
Optional: the region where the incident occurred
incident-environment
Optional: the environment where the incident occurred
In your steps
:
- name: Send PagerDuty alert on failure
if: ${{ failure() }}
uses: miparnisari/action-pagerduty-alert
with:
pagerduty-integration-key: '${{ secrets.PAGERDUTY_INTEGRATION_KEY }}'
pagerduty-dedup-key: github_workflow_failed