Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/crazy-max/ghaction-github-status
GitHub Action to check GitHub Status in your workflow
https://github.com/crazy-max/ghaction-github-status
github github-actions monitoring status statuspage
Last synced: 4 days ago
JSON representation
GitHub Action to check GitHub Status in your workflow
- Host: GitHub
- URL: https://github.com/crazy-max/ghaction-github-status
- Owner: crazy-max
- License: mit
- Created: 2020-05-22T21:59:38.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-10-07T18:19:14.000Z (27 days ago)
- Last Synced: 2024-10-18T07:31:20.276Z (17 days ago)
- Topics: github, github-actions, monitoring, status, statuspage
- Language: TypeScript
- Homepage: https://github.com/marketplace/actions/github-status
- Size: 2.66 MB
- Stars: 35
- Watchers: 3
- Forks: 7
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Codeowners: .github/CODEOWNERS
- Support: .github/SUPPORT.md
Awesome Lists containing this project
- awesome-actions - Check GitHub Status in your Workflow
- fucking-awesome-actions - Check GitHub Status in your Workflow
- awesome-workflows - Check GitHub Status in your Workflow
README
[](https://github.com/crazy-max/ghaction-github-status/releases/latest)
[](https://github.com/marketplace/actions/github-status)
[](https://github.com/crazy-max/ghaction-github-status/actions?workflow=test)
[](https://codecov.io/gh/crazy-max/ghaction-github-status)
[](https://github.com/sponsors/crazy-max)
[](https://www.paypal.me/crazyws)
## About
A GitHub Action to check [GitHub Status](https://www.githubstatus.com/) in your workflow.
___
* [Features](#features)
* [Usage](#usage)
* [Basic workflow](#basic-workflow)
* [Trigger error if GitHub services are down](#trigger-error-if-github-services-are-down)
* [Customizing](#customizing)
* [inputs](#inputs)
* [Contributing](#contributing)
* [License](#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:
```yaml
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.
```yaml
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**](https://github.com/sponsors/crazy-max)
or by making a [PayPal donation](https://www.paypal.me/crazyws) to ensure this
journey continues indefinitely!
Thanks again for your support, it is much appreciated! :pray:
## License
MIT. See `LICENSE` for more details.