GitHub Action
GitHub Status
A GitHub Action to check GitHub Status in your workflow.
- Threshold management for each GitHub service or global (rollup)
- Display status of all services
- Display active incidents and updates
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@v3
-
name: Checkout
uses: actions/checkout@v3
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@v3
with:
overall_threshold: minor
pages_threshold: partial_outage
-
name: Checkout
uses: actions/checkout@v3
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
ormaintenance
.- ² Accepted values are
operational
,degraded_performance
,partial_outage
major_outage
,under_maintenance
.
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! 🙏
MIT. See LICENSE
for more details.