Skip to content

Add details about running GitHub actions tests locally #9363

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Aug 19, 2025
Merged

Add details about running GitHub actions tests locally #9363

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
75d69de
Add details to the README about GitHub actions tests
cecile75 Aug 14, 2025
5815f4c
Update .github/workflows/README.md
cecile75 Aug 14, 2025
30becd8
Remove concrete example
cecile75 Aug 14, 2025
2819125
Merge branch 'master' into cecile/githubactions
cecile75 Aug 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions .github/workflows/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,9 +150,10 @@ find .github/workflows -name "*.yaml" -exec awk '/uses:/{print $2 ","}' {} \; |

## Testing

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

> [!WARNING]
> Locally running workflows will still query GitHub backend and will update the GitHub project accordingly.
> Pay extra attention to the workflow jobs you trigger to not create development disruption.
> Locally running workflows will still query GitHub backend and will update the GitHub project accordingly.
> For example, running 'tests/add-milestone-to-pull-requests/test-pull-request.sh' locally will add a milestone, on this github repository, to the PR whose ID is written in 'tests/add-milestone-to-pull-requests/payload-pull-request.json' as 'pull_request.number', if it hasn't one already.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💭 thought: ‏I would not give a specific test scenario as example as it will increase the extra work maintaining it.
But having an explicit notice about "tests will run against the repository and will potentially alter existing issues, milestones and releases."

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wanted to write a concrete example as it's more meaningful to me but I agree that it's not great for maintenance.
Talking about "existing issues, milestones and releases" is already an improvement, let's go with that.

> Pay extra attention to the workflow jobs you trigger to not create development disruption.
Loading