loading...

GitHub Status action

crazymax profile image CrazyMax ・2 min read

GitHub logo crazy-max / ghaction-github-status

:octocat: GitHub Action to check GitHub Status in your workflow

GitHub release GitHub marketplace Test workflow Codecov Become a sponsor Paypal Donate

About

A GitHub Action to check GitHub Status in your workflow.

If you are interested, check out my other :octocat: GitHub Actions!


Features

  • Threshold management for each GitHub service or global (rollup)
  • Display status of all services
  • Display active incidents and updates

Usage

Basic workflow

The following workflow is purely informative and will only display the current status of GitHub services:

GitHub Status - OK

name: build
on: push
jobs
  build:
    runs-on: ubuntu-latest
    steps:
      -
        name: Check GitHub Status
        uses: crazy-max/ghaction-github-status@v1
      -
        name: Checkout
        uses: actions/checkout@v2

Trigger error if GitHub services are down

In the example below we will set some status thresholds so that the job can fail if these thresholds are exceeded.

This can be useful if you have an action that publishes to GitHub…

With yesterday's disruption on GitHub, I thought it would be a good idea to create a GitHub Action to check the status of GitHub's services. So here it is!

Features

  • Threshold management for each GitHub service or global (rollup)
  • Display status of all services
  • Display active incidents and updates

Basic worflow

The following workflow is purely informative and will only display the current status of GitHub services:

GitHub Status OK

name: build

on: push

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      -
        name: Check GitHub Status
        uses: crazy-max/ghaction-github-status@v1
      -
        name: Checkout
        uses: actions/checkout@v2

Trigger error if GitHub services are down

In the example below we will set some status thresholds so that the job can fail if these thresholds are exceeded.

This can be useful if you have an action that publishes to GitHub Pages but the service is down.

GitHub Status - Failed

name: build

on: push

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      -
        name: Check GitHub Status
        uses: crazy-max/ghaction-github-status@v1
        with:
          overall_threshold: minor
          pages_threshold: partial_outage
      -
        name: Checkout
        uses: actions/checkout@v2

Many others thresholds are available like Git Operations, GitHub Packages, Webhooks, etc...

Check it out: https://github.com/crazy-max/ghaction-github-status/


Support this project by becoming a sponsor on GitHub πŸ‘ or by making a Paypal donation to ensure this journey continues indefinitely! πŸš€

Thanks again for your support, it is much appreciated! πŸ™

Discussion

pic
Editor guide