Skip to content

Latest commit

 

History

History
117 lines (85 loc) · 4.81 KB

README.md

File metadata and controls

117 lines (85 loc) · 4.81 KB
Raw

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@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.

GitHub Status - Failed

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

Name Type Description
overall_threshold¹ String Defines threshold for overall status (also called rollup) of GitHub to fail the job
git_threshold² String Defines threshold for Git Operations to fail the job
api_threshold² String Defines threshold for API Requests to fail the job
webhooks_threshold² String Defines threshold for Webhooks to fail the job
issues_threshold² String Defines threshold for Issues to fail the job
prs_threshold² String Defines threshold for Pull Requests to fail the job
actions_threshold² String Defines threshold for GitHub Actions to fail the job
packages_threshold² String Defines threshold for GitHub Packages to fail the job
pages_threshold² String Defines threshold for GitHub Pages to fail the job
  • ¹ Accepted values are minor, major, critical or maintenance.
  • ² Accepted values are operational, degraded_performance, partial_outage major_outage, under_maintenance.

Contributing

Want to contribute? Awesome! The most basic way to show your support is to star the project, or to raise issues. If you want to open a pull request, please read the contributing guidelines.

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.