Skip to content

Commit 4e3f8fa

Browse files
committed
doc: add instructions for using act
1 parent 81712ff commit 4e3f8fa

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

ci/README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,3 +24,29 @@ CI_CONFIG=ci/configs/olddeps.bash ci/scripts/run.sh
2424
```
2525

2626
By default CI jobs will reuse their build directories. `CI_CLEAN=1` can be specified to delete them before running instead.
27+
28+
### Running workflows with `act`
29+
30+
You can run either the entire workflow or a single matrix entry locally. On
31+
macOS or Linux:
32+
33+
1. Install [`act`](https://github.com/nektos/act) and either Docker or
34+
Podman.
35+
2. Inside the Podman VM, create a named volume for the Nix store (ext4,
36+
case-sensitive) so builds persist across runs. Recreate it any time you want
37+
a clean cache:
38+
```bash
39+
podman volume create libmultiprocess-nix
40+
```
41+
3. From the repo root, launch the workflow. The example below targets the
42+
sanitize matrix entry; drop the `--matrix` flag to run every configuration.
43+
```bash
44+
act \
45+
--reuse \
46+
-P ubuntu-latest=ghcr.io/catthehacker/ubuntu:act-24.04 \
47+
--container-options "-v libmultiprocess-nix:/nix" \
48+
-j build \
49+
--matrix config:sanitize
50+
```
51+
52+

0 commit comments

Comments
 (0)