spatie/github-actions-watcher

A CLI tool to see the status of all your GitHub Actions workflows in real time

1.0.7 2022-03-01 16:34 UTC

Requires

• php: ^8.0

Requires (Dev)

• guzzlehttp/guzzle: ^7.4
• illuminate/http: ^9.0
• illuminate/view: ^9.0
• laravel-zero/framework: ^9.0
• mockery/mockery: ^1.5.0
• myclabs/php-enum: ^1.8
• nunomaduro/larastan: ^2.0
• nunomaduro/termwind: ^1.0
• pestphp/pest: ^1.21
• spatie/ray: ^1.32
• spatie/valuestore: ^1.3.1
• symfony/process: ^6.0

MIT

• Freek Van der Herten

• spatie
• github-actions-watcher

README

A CLI tool to see the status of all your GitHub Actions workflows in real time

The official GitHub CLI allows you to monitor a single workflow on the terminal. Using our GitHub Actions Watcher tool you can monitor the results of all your GitHub Actions. When installed, you can just execute actions-watcher to see all results.

By default, the watcher will use the git repo and branch of the directory it is launched in. It will keep polling and refreshing results until all workflows of your repo have been completed.

Support us

We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products.

We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on our contact page. We publish all received postcards on our virtual postcard wall.

Source diving this tool

In this stream on YouTube, we'll guide you through the entire source code of the tool.

Installation

You can install the tool via composer:

composer global require spatie/github-actions-watcher

Usage

You can just execute the tool on your cli.

actions-watcher

By default, the watcher will use the git repo and branch of the directory it is launched in. It will keep polling and refreshing results until all workflows of your repo have been completed.

Authenticating with GitHub

To see results of private repos, you must authenticate with GitHub. Even when working with public repos, we highly recommend authenticating, as you'll get higher rate limit when the tools communicates with GitHub.

You can authenticate with GitHub by executing this command:

actions-watcher login

After having completed the login flow, a token will be stored on your disk. At no point, Spatie can see any data of your repos or user.

To destroy the token on your hard disk, execute the logout command.

actions-watcher logout

Single pass

If you don't want to poll for new results, but just want to see current results use the --single-pass option

actions-watcher --single-pass

Using an alternative repo and/or branch

By default, the watcher will use the git repo and branch of the directory it is launched in. It will keep polling and refreshing results until all workflows of your repo have been completed.

If you want to use another repo or branch, use the --repo and --branch flags.

actions-watcher --repo=your-organisation/your-repo-name --branch=other-branch

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• Freek Van der Herten
• All Contributors

A big thank you to Francisco Madeira and Owen Voke for helping us with the layout of the screens.

License

The MIT License (MIT). Please see License File for more information.