The ghaction-github-status from crazy-max

ghaction-github-status's Introduction

About

A GitHub Action to check GitHub Status in your workflow.

Features
Usage
- Basic workflow
- Trigger error if GitHub services are down
Customizing
- inputs
Contributing
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@v4
      -
        name: Checkout
        uses: actions/checkout@v3

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@v4
        with:
          overall_threshold: minor
          pages_threshold: partial_outage
      -
        name: Checkout
        uses: actions/checkout@v3

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 Actions to fail the job
`packages_threshold`²	String	Defines threshold for Packages to fail the job
`pages_threshold`²	String	Defines threshold for Pages to fail the job
`codespaces_threshold`²	String	Defines threshold for Codespaces to fail the job
`copilot_threshold`²	String	Defines threshold for Copilot 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. 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.

ghaction-github-status's People

Contributors

Stargazers

Watchers

ghaction-github-status's Issues

GITHUB_TOKEN permissions used by this action

At https://github.com/step-security/secure-workflows we are building a knowledge-base (KB) of GITHUB_TOKEN permissions needed by different GitHub Actions. When developers try to set minimum token permissions for their workflows, they can use this knowledge-base instead of trying to research permissions needed by each GitHub Action they use.

Below you can see the KB of your GITHUB Action.

name: 'GitHub Status' # crazy-max/ghaction-github-status
# GITHUB_TOKEN not used

If you think this information is not accurate, or if in the future your GitHub Action starts using a different set of permissions, please create an issue at https://github.com/step-security/secure-workflows/issues to let us know.

This issue is automatically created by our analysis bot, feel free to close after reading :)

References:

GitHub asks users to define workflow permissions, see https://github.blog/changelog/2021-04-20-github-actions-control-permissions-for-github_token/ and https://docs.github.com/en/actions/security-guides/automatic-token-authentication#modifying-the-permissions-for-the-github_token for securing GitHub workflows against supply-chain attacks.

Setting minimum token permissions is also checked for by Open Source Security Foundation (OpenSSF) Scorecards. Scorecards recommend using https://github.com/step-security/secure-workflows so developers can fix this issue in an easier manner.

Seeing "... is not implemented" status messages

Behaviour

I've recently started seeing some ".... is not implemented" status messages, where - if I remember correctly - those statuses were previously reported via this action.

In particular I noticed the GitHub Pages status no longer reporting, while I use that to prevent potentially borking a GH Pages website if a deploy is run while there is an outage.

Steps to reproduce this issue

      - name: Check GitHub Pages status
        uses: crazy-max/ghaction-github-status@v3
        with:
          pages_threshold: major_outage

Expected behaviour

Statuses being reported for all systems.

Actual behaviour

Recommend Projects

crazy-max / ghaction-github-status Goto Github PK