Manually running a workflow

When a workflow is configured to run on the workflow_dispatch event, you can run the workflow using the REST API or from the Actions tab on GitHub.

GitHub Actions is available with GitHub Free, GitHub Pro, GitHub Free for organizations, GitHub Team, GitHub Enterprise Cloud, GitHub Enterprise Server, and GitHub One. GitHub Actions is not available for private repositories owned by accounts using legacy per-repository plans. For more information, see "GitHub's products."

In this article

Did this doc help you?

To run a workflow manually, the workflow must be configured to run on the workflow_dispatch event. For more information, see "Events that trigger workflows."

Running a workflow on GitHub

To trigger the workflow_dispatch event on GitHub, your workflow must be in the default branch. Follow these steps to manually trigger a workflow run.

Read access to the repository is required to perform these steps.

  1. On GitHub, navigate to the main page of the repository.
  2. Under your repository name, click Actions.
    Actions tab in the main repository navigation
  3. In the left sidebar, click the workflow you want to run.
    actions select workflow
  4. Above the list of workflow runs, select Run workflow.
    actions workflow dispatch
  5. Select the branch where the workflow will run and type the input parameters used by the workflow. Click Run workflow.
    actions manually run workflow

Running a workflow using the REST API

When using the REST API, you configure the inputs and ref as request body parameters. If the inputs are omitted, the default values defined in the workflow file are used.

For more information about using the REST API, see the "Create a workflow dispatch event."

Did this doc help you?