Skip to content

Commit dec3ce1

Browse files
Add details about running GitHub actions tests locally (#9363)
* Add details to the README about GitHub actions tests --------- Co-authored-by: Bruce Bujon <[email protected]>
1 parent 10f539b commit dec3ce1

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

.github/workflows/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -151,8 +151,9 @@ find .github/workflows -name "*.yaml" -exec awk '/uses:/{print $2 ","}' {} \; |
151151
## Testing
152152

153153
Workflows can be locally tested using the [`act` CLI](https://github.com/nektos/act/).
154+
Docker and [GiHub CLI](https://cli.github.com/) need also to be installed.
154155
The [.github/workflows/tests/](./tests) folder contains test scripts and event payloads to locally trigger workflows.
155156

156157
> [!WARNING]
157-
> Locally running workflows will still query GitHub backend and will update the GitHub project accordingly.
158+
> Local workflow tests run against the repository and will potentially alter existing issues, milestones and releases.
158159
> Pay extra attention to the workflow jobs you trigger to not create development disruption.

0 commit comments

Comments
 (0)