crazy-max / ghaction-github-status

About

A GitHub Action to check GitHub Status in your workflow.

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

• Features
• Usage
  • Basic workflow
  • Trigger error if GitHub services are down
• Customizing
  • inputs
• Keep up-to-date with GitHub Dependabot
• How can I help?
• License

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:

name: build

on: push

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      -
        name: Check GitHub Status
        uses: crazy-max/ghaction-github-status@v2
      -
        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.

name: build

on: push

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

Customizing

inputs

Following inputs can be used as step.with keys

• ¹ Accepted values are minor, major, critical or maintenance.
• ² Accepted values are operational, degraded_performance, partial_outage major_outage, under_maintenance.

Keep up-to-date with GitHub Dependabot

Since Dependabot has native GitHub Actions support, to enable it on your GitHub repo all you need to do is add the .github/dependabot.yml file:

version: 2
updates:
  # Maintain dependencies for GitHub Actions
  - package-ecosystem: "github-actions"
    directory: "/"
    schedule:
      interval: "daily"

How can I help?

All kinds of contributions are welcome 🙌! The most basic way to show your support is to star 🌟 the project, or to raise issues 💬 You can also 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! 🙏

License

MIT. See LICENSE for more details.