From d711aca64a7a7292069f819a25c6bb26832e9fcb Mon Sep 17 00:00:00 2001 From: Mike McCready <66998419+MikeMcC399@users.noreply.github.com> Date: Sun, 10 Nov 2024 17:27:11 +0100 Subject: [PATCH 1/2] docs: update manual-trigger section --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 3b09db175..55737b9ba 100644 --- a/README.md +++ b/README.md @@ -1510,7 +1510,11 @@ pinging url https://example.cypress.io for 30 seconds ### Manual trigger -If you add `workflow_dispatch` event to your workflow, you will be able to start the workflow by clicking a button on the GitHub page, see the [Test External Site Using GitHub Actions](https://www.youtube.com/watch?v=4TeSOj2Iy_Q) video. +Each of the `example-*` workflows in the [.github/workflows](https://github.com/cypress-io/github-action/tree/master/.github/workflows) directory is configured to trigger on a `workflow_dispatch` event. This allows any of these workflows to be run manually. + +[Fork](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo) and [clone](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo#cloning-your-forked-repository) this repository to try out the examples live in your own repository copy. Refer to the GitHub Actions documentation [Manually running a workflow](https://docs.github.com/en/actions/managing-workflow-runs-and-deployments/managing-workflow-runs/manually-running-a-workflow) which explains how to run a workflow from the Actions tab on GitHub. Workflows can also be run using the GitHub CLI or the REST API. + +If you add `workflow_dispatch` event to any of your own workflows, you will be able to run your workflow manually in the same way. ### Outputs From d34a3dd88bbc101474f6fdeed3cf931318920bdd Mon Sep 17 00:00:00 2001 From: Mike McCready <66998419+MikeMcC399@users.noreply.github.com> Date: Tue, 12 Nov 2024 15:28:31 +0100 Subject: [PATCH 2/2] re-write last paragraph --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 55737b9ba..609aa6d9e 100644 --- a/README.md +++ b/README.md @@ -1514,7 +1514,7 @@ Each of the `example-*` workflows in the [.github/workflows](https://github.com/ [Fork](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo) and [clone](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo#cloning-your-forked-repository) this repository to try out the examples live in your own repository copy. Refer to the GitHub Actions documentation [Manually running a workflow](https://docs.github.com/en/actions/managing-workflow-runs-and-deployments/managing-workflow-runs/manually-running-a-workflow) which explains how to run a workflow from the Actions tab on GitHub. Workflows can also be run using the GitHub CLI or the REST API. -If you add `workflow_dispatch` event to any of your own workflows, you will be able to run your workflow manually in the same way. +If you configure a `workflow_dispatch` event in your own workflows, you will be able to run them manually in the same way. ### Outputs