Skip to content
You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
play

GitHub Action

PagerDuty Change Events

v1.0.0

PagerDuty Change Events

play

PagerDuty Change Events

Create a PagerDuty Change Event

Installation

Copy and paste the following snippet into your .yml file.

              

- name: PagerDuty Change Events

uses: PagerDuty/[email protected]

Learn more about this action in PagerDuty/pagerduty-change-events-action

Choose a version

PagerDuty Change Events GitHub Action

This action creates a PagerDuty change event. Change events help you track deploys, build completion, configuration updates, etc., providing contextual information that is critical during incident triage.

Getting Started

Before you can use this action you'll need to have a PagerDuty service configured with an integration. To add a GitHub integration to your service, follow these instructions. Upon completing those steps you should receive an integration key that you can use with this action.

Currently only push and pull_request events are handled, and for pull_request events, a change event will only be created when the pull request is merged. You can choose which event and which branches change events should be created for in your workflow configuration.

Inputs

integration-key

Required The integration key that identifies the PagerDuty service the change was made to.

Example usage

on:
  push:
    branches:
      - master
  pull_request:
    branches:
      - master
    types:
      - closed

jobs:
  action-test-job:
    runs-on: ubuntu-latest
    name: Deploying the application
    steps:
      - name: Create a change event
        uses: actions/pagerduty-change-events-action@master
        with:
          integration-key: '<your-integration-key-here>'