GitHub · Run a workflow — Starts a GitHub Actions workflow that has workflow_dispatch — starts a workflow in your repository's .github/workflows folder, as Run workflow in GitHub's Actions tab does. Use it to deploy, build or run a script from a Bizomate workflow.

Who can do this

Workspace Admins and Editors, on every plan. Viewers see the step's settings but cannot change them.

Before you start

  • A GitHub connection whose token has the repository and Actions: Read and write (classic: repo) — see Connect GitHub.
  • A GitHub Actions workflow whose file has a workflow_dispatch trigger under on:. Without it, GitHub cannot start it from outside.

Steps

  1. Select + where the step should go. In the step picker, open Apps, select GitHub, then Run a workflow. Or search GitHub.
  2. In Connection, choose your GitHub connection.
  3. In Repository, choose the repository — for example consulace/billing-service.
  4. In Workflow, choose the Actions workflow. The list shows each by its name and file — Deploy · .github/workflows/deploy.yml.
  5. In Branch, choose the branch to run it on — for example main.
  6. Under Inputs, select Add a field for each input the workflow takes — The workflow's inputs, as its file names them. Type the input's name in the first box — environment — and its value in Value — production, or a value from an earlier step.
  7. Select Run this step to try it. This starts a real run in GitHub.

Output

Field What it is
started true — GitHub accepted the request.
workflow GitHub's id for the workflow that was started.
ref The branch it runs on.

Good to know

  • The step does not wait for the GitHub run, and GitHub gives no id for it. To act when it finishes, start another workflow with GitHub · Workflow run finished — see Start a workflow from GitHub events.
  • Inputs are sent as text. A boolean input takes true or false; a choice input takes one of its options exactly.
  • An input the workflow does not declare is refused by GitHub. Leave out inputs you do not need; GitHub uses their defaults.
  • The workflow file on the chosen branch is the one that runs. A workflow that exists only on another branch cannot run on this one.
  • Each item runs the step once. Ten items start ten runs in GitHub.

If something goes wrong

What you see Why What to do
GitHub refused: Workflow does not have 'workflow_dispatch' trigger. The workflow cannot be started from outside. Add workflow_dispatch: under on: in its file.
GitHub refused: Unexpected inputs provided: … An input name is not in the workflow file. Check the names under Inputs against the file.
GitHub refused: No ref found for: … The branch does not exist. Choose it from the list.
Nothing to pick — "This repository has no Actions workflows. Add one under .github/workflows, with workflow_dispatch to run it from here." The repository has no workflow files. Add one in GitHub, then select Refresh.
GitHub refused: Resource not accessible by personal access token. Check the connection's details on Connections. The token lacks Actions: Read and write. Add the permission in GitHub.
Workflow is empty when the step ran — … / Branch is empty when the step ran — … A value came out empty. Choose them from the lists.