Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/psilore/status
A simple script to get workflow status & conclusion of either all workflows in an GitHub organisation or repositories belonging to a GitHub team.
https://github.com/psilore/status
bash github-workflows
Last synced: 4 days ago
JSON representation
A simple script to get workflow status & conclusion of either all workflows in an GitHub organisation or repositories belonging to a GitHub team.
- Host: GitHub
- URL: https://github.com/psilore/status
- Owner: psilore
- License: mit
- Created: 2024-09-14T08:51:46.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-09-14T09:19:33.000Z (3 months ago)
- Last Synced: 2024-10-31T10:04:47.349Z (about 2 months ago)
- Topics: bash, github-workflows
- Language: Shell
- Homepage:
- Size: 61.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
status
A simple script to get workflow status & conclusion of either all workflows in an GitHub organisation or repositories belonging to a GitHub team.
Heavily influenced by [LF Workflow Dash](https://github.com/lincc-frameworks/lf-workflow-dash)
## Prerequisites
- [git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
- [gh-cli](https://github.com/cli/cli?tab=readme-ov-file#installation)
- [jq](https://jqlang.github.io/jq/download/)
## Usage
Status scan uses GitHub API to check status of owners workflow and will produce 2 files, `active_repos.txt` and if a workflow run has been concluded a failure it will create a file `failed_workflows.txt`
**Tip:** If you have certain workflows that is vital, you can have a check if file `failed_workflows.txt` exists, alerts a slack channel with failed workflows detected on a schedule.
1. Clone repository
```sh
git clone https://github.com/psilore/status.git
```
1. Navigate to directory
```sh
cd status
```
### Scan all workflows in an GitHub organisation
```sh
bash status.sh -o [OWNER]
```
### Scan all workflows of a GitHub team within an organisation
```sh
bash status.sh -o [OWNER] -t [TEAM_SLUG]
```