Debug GitHub Actions workflows locally with step-by-step execution
Project description
gha-debug
Debug GitHub Actions workflows locally with step-by-step execution
Overview
gha-debug is a lightweight CLI tool that helps developers test and debug GitHub Actions workflows locally before pushing to CI. Unlike heavy Docker-based solutions, it provides fast validation, clear step-by-step execution visibility, and helpful error messages.
Installation
pip install gha-debug
Usage
Run a workflow locally
gha-debug run .github/workflows/test.yml
Run a specific job with verbose output
gha-debug run .github/workflows/build.yml --job build --verbose
List all workflows and jobs
gha-debug list
Show environment variables for a job
gha-debug env .github/workflows/deploy.yml --job deploy
Validate workflow syntax
gha-debug validate .github/workflows/*.yml
Features
- ✅ Parse and validate GitHub Actions workflow YAML files
- ✅ List all workflows, jobs, and steps with clear formatting
- ✅ Run workflows locally with simulated GitHub Actions environment
- ✅ Show detailed step-by-step execution with timing information
- ✅ Display environment variables and contexts for debugging
- ✅ Validate workflow syntax and catch common errors before pushing
- ✅ Colorized output for better readability
- ✅ Support for filtering by specific job within a workflow
Why gha-debug?
Debugging GitHub Actions workflows is painful:
- Logs are hard to navigate in the web interface
- Re-running failed jobs wastes time
- No simple local testing that mirrors the CI environment
gha-debug solves this by providing a fast feedback loop. It doesn't try to perfectly replicate GitHub's environment (which causes compatibility issues), but instead focuses on what developers need most: quick validation and clear error messages.
Example Output
$ gha-debug run .github/workflows/test.yml
Running workflow: test.yml
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
Job: test
✓ Checkout code (1.2s)
✓ Setup Python 3.11 (0.8s)
✓ Install dependencies (4.5s)
✓ Run tests (12.3s)
✓ Workflow completed successfully in 18.8s
License
MIT License - Copyright (c) 2026 Intellirim
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file gha_debug-0.2.0.tar.gz.
File metadata
- Download URL: gha_debug-0.2.0.tar.gz
- Upload date:
- Size: 14.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.10.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
3fbe09abb440db5d0f4043f41204bacfc6589731a7453e2f7794fcee0d6f9238
|
|
| MD5 |
077fab228321856b8eecfcfe5a45d468
|
|
| BLAKE2b-256 |
e88fb92e4d89ad21b0b406bd6d76743c7ded53452581a30c90ea6af33f22fcd3
|
File details
Details for the file gha_debug-0.2.0-py3-none-any.whl.
File metadata
- Download URL: gha_debug-0.2.0-py3-none-any.whl
- Upload date:
- Size: 13.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.10.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5f56f45f6eee50c7600236faa580c54da8bad5ea0eae1f3625410c42e7f85d6e
|
|
| MD5 |
0f730abe5361a7130d7e04d7edcae26c
|
|
| BLAKE2b-256 |
117d6c36e8c9eb38a1b29372c5329d3d7331fb8f7e67b92e3dac743998e31058
|