Skip to content

Commit 6fbc114

Browse files
committed
modern CI checks instructions
1 parent 94a0a92 commit 6fbc114

File tree

1 file changed

+32
-1
lines changed

1 file changed

+32
-1
lines changed

CONTRIBUTING.md

Lines changed: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,38 @@ We require that your commit messages match our template. The easiest way to do t
5656

5757
### Run CI checks locally
5858

59-
You can run the Github Actions workflows locally using [act](https://github.com/nektos/act). For detailed steps on how to do this please see [https://github.com/swiftlang/github-workflows?tab=readme-ov-file#running-workflows-locally](https://github.com/swiftlang/github-workflows?tab=readme-ov-file#running-workflows-locally).
59+
You can run the Github Actions workflows locally using
60+
[act](https://github.com/nektos/act). To run all the jobs that run on a pull
61+
request, use the following command:
62+
63+
```
64+
% act pull_request
65+
```
66+
67+
To run just a single job, use `workflow_call -j <job>`, and specify the inputs
68+
the job expects. For example, to run just shellcheck:
69+
70+
```
71+
% act workflow_call -j soundness --input shell_check_enabled=true
72+
```
73+
74+
To bind-mount the working directory to the container, rather than a copy, use
75+
`--bind`. For example, to run just the formatting, and have the results
76+
reflected in your working directory:
77+
78+
```
79+
% act --bind workflow_call -j soundness --input format_check_enabled=true
80+
```
81+
82+
If you'd like `act` to always run with certain flags, these can be be placed in
83+
an `.actrc` file either in the current working directory or your home
84+
directory, for example:
85+
86+
```
87+
--container-architecture=linux/amd64
88+
--remote-name upstream
89+
--action-offline-mode
90+
```
6091

6192
## How to contribute your work
6293

0 commit comments

Comments
 (0)