From 75d69de914b8b416128d1d24d1381652b8a63d00 Mon Sep 17 00:00:00 2001 From: cecile75 <32452337+cecile75@users.noreply.github.com> Date: Thu, 14 Aug 2025 13:50:39 +0200 Subject: [PATCH 1/3] Add details to the README about GitHub actions tests --- .github/workflows/README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/.github/workflows/README.md b/.github/workflows/README.md index d215dfd58fc..3c7684af232 100644 --- a/.github/workflows/README.md +++ b/.github/workflows/README.md @@ -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. +> Pay extra attention to the workflow jobs you trigger to not create development disruption. From 5815f4ce1ea1d0729721b1e6e5d3a162e9a8d331 Mon Sep 17 00:00:00 2001 From: cecile <32452337+cecile75@users.noreply.github.com> Date: Thu, 14 Aug 2025 14:17:07 +0200 Subject: [PATCH 2/3] Update .github/workflows/README.md Co-authored-by: Bruce Bujon --- .github/workflows/README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/workflows/README.md b/.github/workflows/README.md index 3c7684af232..bf3345761e4 100644 --- a/.github/workflows/README.md +++ b/.github/workflows/README.md @@ -150,7 +150,8 @@ 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/). Docker and GiHub CLI need also to be installed. +Workflows can be locally tested using the [`act` CLI](https://github.com/nektos/act/). +Docker and [GiHub CLI](https://cli.github.com/) need also to be installed. The [.github/workflows/tests/](./tests) folder contains test scripts and event payloads to locally trigger workflows. > [!WARNING] From 30becd8b1a316372d16788239131feda10855cb5 Mon Sep 17 00:00:00 2001 From: cecile75 <32452337+cecile75@users.noreply.github.com> Date: Thu, 14 Aug 2025 14:36:18 +0200 Subject: [PATCH 3/3] Remove concrete example --- .github/workflows/README.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/.github/workflows/README.md b/.github/workflows/README.md index bf3345761e4..737db03488e 100644 --- a/.github/workflows/README.md +++ b/.github/workflows/README.md @@ -155,6 +155,5 @@ Docker and [GiHub CLI](https://cli.github.com/) 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. -> 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. -> Pay extra attention to the workflow jobs you trigger to not create development disruption. +> Local workflow tests run against the repository and will potentially alter existing issues, milestones and releases. +> Pay extra attention to the workflow jobs you trigger to not create development disruption.