Skip to content

OpenAPI Release Notifier

GitHub App

OpenAPI Release Notifier

GitHub App

Notify consumers of github/openapi a new release is published.

Emits a repository_dispatch event with { "event_type": "github-openapi-release", "client_payload": <release webhook event payload> } for every release event in https://github.com/github/rest-api-description/releases/

Example workflow to act on a new release of GitHub's OpenAPI spec, filtered by only the published action

name: Update OpenAPI 
on:
  repository_dispatch:
    types: [github-openapi-release]

jobs:
  published:
    runs-on: ubuntu-latest
    if: github.event.client_payload.action == 'published'
    steps:
      - uses: actions/checkout@v2
      - uses: actions/setup-node@v1
        with:
          node-version: 14
      - run: npm ci
      - run: npm run update-endpoints
        env:
          VERSION: ${{ github.event.client_payload.release.tag_name }}

Developer

OpenAPI Release Notifier is owned and operated by GitHub with separate terms of service, privacy policy, and support documentation.

Report abuse