From 701479410c9c90189936d69e6e9121ed47bfb642 Mon Sep 17 00:00:00 2001 From: Joe Clark <31087804+jc-clark@users.noreply.github.com> Date: Tue, 27 Jun 2023 14:29:27 -0700 Subject: [PATCH] Add documentation to make `workflow_dispatch` trigger requirement more explicit (#38405) Co-authored-by: Ben Ahmady <32935794+subatoi@users.noreply.github.com> --- .../using-workflows/manually-running-a-workflow.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/content/actions/using-workflows/manually-running-a-workflow.md b/content/actions/using-workflows/manually-running-a-workflow.md index 0a78d59bd4..59c02a561b 100644 --- a/content/actions/using-workflows/manually-running-a-workflow.md +++ b/content/actions/using-workflows/manually-running-a-workflow.md @@ -15,7 +15,9 @@ redirect_from: ## Configuring a workflow to run manually -To run a workflow manually, the workflow must be configured to run on the `workflow_dispatch` event. To trigger the `workflow_dispatch` event, your workflow must be in the default branch. For more information about configuring the `workflow_dispatch` event, see "[AUTOTITLE](/actions/using-workflows/events-that-trigger-workflows#workflow_dispatch)". +To run a workflow manually, the workflow must be configured to run on the `workflow_dispatch` event. + +To trigger the `workflow_dispatch` event, your workflow must be in the default branch. For more information about configuring the `workflow_dispatch` event, see "[AUTOTITLE](/actions/using-workflows/events-that-trigger-workflows#workflow_dispatch)." {% data reusables.repositories.permissions-statement-write %} @@ -32,7 +34,12 @@ To run a workflow manually, the workflow must be configured to run on the `workf {%- else -%} ![Screenshot of the "Actions" page. Features apart from one workflow in the left sidebar are grayed out.](/assets/images/help/repository/actions-select-workflow.png) {%- endif %} -1. Above the list of workflow runs, select **Run workflow**. +1. Above the list of workflow runs, click the **Run workflow** button. + {% note %} + + **Note:** To see the **Run workflow** button, your workflow file must use the `workflow_dispatch` event trigger. Only workflow files that use the `workflow_dispatch` event trigger will have the option to run the workflow manually using the **Run workflow** button. For more information about configuring the `workflow_dispatch` event, see "[AUTOTITLE](/actions/using-workflows/events-that-trigger-workflows#workflow_dispatch)." + + {% endnote %} ![Screenshot of a workflow page. Above the list of workflow runs, a button, labeled "Run workflow", is outlined in dark orange.](/assets/images/help/actions/actions-workflow-dispatch.png) 1. Select the **Branch** dropdown menu and click a branch to run the workflow on.