Skip to content

Commit 49ecb54

Browse files
committed
docs: add section on running CI locally with act and update troubleshooting links
1 parent 2e7d87d commit 49ecb54

File tree

1 file changed

+53
-2
lines changed

1 file changed

+53
-2
lines changed

README.md

Lines changed: 53 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,9 @@ To install: ```pip install isee```
1515
7. [Hosting](#hosting)
1616
8. [How to setup CI](#how-to-setup-ci)
1717
* [For a GitHub repository](#for-a-github-repository)
18-
9. [Useful resources](#useful-resources)
19-
10. [Troubleshooting](#troubleshooting)
18+
9. [Running CI Locally](#running-ci-locally)
19+
10. [Useful resources](#useful-resources)
20+
11. [Troubleshooting](#troubleshooting)
2021
* [Common non fatal error during publishing](#common-non-fatal-error-during-publishing)
2122
* [Github token problems (e.g. tagging)](#github-token-problems)
2223
* [Version tag misalignment](#version-tag-misalignment)
@@ -114,6 +115,56 @@ Consider using [wads](https://pypi.org/project/wads/) to automatically validate
114115
pack check-in 'Your commit message.'
115116
```
116117

118+
<a id="running-ci-locally"></a>
119+
# Running CI Locally
120+
121+
You can run your GitHub Actions CI workflow locally before pushing, using [`act`](https://github.com/nektos/act). This helps catch issues early and saves CI minutes.
122+
123+
## Quick Start
124+
125+
```bash
126+
# Check if dependencies are installed
127+
python -m isee.local_cli --check-deps
128+
129+
# Run your entire CI workflow locally
130+
python -m isee.local_cli
131+
132+
# Run a specific job (e.g., validation)
133+
python -m isee.local_cli -j validation
134+
135+
# Dry run to see what would execute
136+
python -m isee.local_cli --dry-run
137+
```
138+
139+
## Prerequisites
140+
141+
Install `act` and ensure Docker is running:
142+
143+
**macOS:**
144+
```bash
145+
brew install act
146+
```
147+
148+
**Linux:**
149+
```bash
150+
curl https://raw.githubusercontent.com/nektos/act/master/install.sh | sudo bash
151+
```
152+
153+
## Common Options
154+
155+
```bash
156+
# Run with specific Python version
157+
python -m isee.local_cli -j validation -m python-version:3.10
158+
159+
# Use custom workflow file
160+
python -m isee.local_cli -w .github/workflows/test.yml
161+
162+
# Quiet mode (less output)
163+
python -m isee.local_cli -q
164+
```
165+
166+
For detailed documentation, see [LOCAL_CLI_USAGE.md](https://github.com/i2mint/isee/blob/master/LOCAL_CLI_USAGE.md).
167+
117168
<a id="useful-resources"></a>
118169
# Useful resources
119170

0 commit comments

Comments
 (0)