English
No results found.

Explore by product

GitHub Actions
  • Get started
  • Account and profile
  • Authentication
  • Repositories
  • GitHub
  • Enterprise administrators
  • Billing and payments
  • Organizations
  • Code security
  • GitHub Issues
  • GitHub Actions
  • GitHub Codespaces
  • GitHub Packages
  • Search on GitHub
  • Developers
  • REST API
  • GraphQL API
  • GitHub CLI
  • GitHub Discussions
  • GitHub Sponsors
  • Building communities
  • GitHub Pages
  • Education
  • GitHub Desktop
  • Atom
  • Electron
  • CodeQL
  • npm
    • English
  • English
  • 简体中文 (Simplified Chinese)
  • 日本語 (Japanese)
  • Español (Spanish)
  • Português do Brasil (Portuguese)

    • This version of GitHub Enterprise was discontinued on 2021-09-23. No patch releases will be made, even for critical security issues. For better performance, improved security, and new features, upgrade to the latest version of GitHub Enterprise. For help with the upgrade, contact GitHub Enterprise support.

    Article version

    In this article

    Manually running a workflow

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

    Note: GitHub Actions was available for GitHub Enterprise Server 2.22 as a limited beta. The beta has ended. GitHub Actions is now generally available in GitHub Enterprise Server 3.0 or later. For more information, see the GitHub Enterprise Server 3.0 release notes.


    Note: GitHub-hosted runners are not currently supported on GitHub Enterprise Server. You can see more information about planned future support on the GitHub public roadmap.

    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 "Events that trigger workflows".

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

    Running a workflow

    1. On your GitHub Enterprise Server instance, 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. Use the Branch dropdown to select the workflow's branch, and type the input parameters. Click Run workflow. actions manually run workflow

    To learn more about GitHub CLI, see "About GitHub CLI."

    To run a workflow, use the workflow run subcommand. Replace the workflow parameter with either the name, ID, or file name of the workflow you want to run. For example, "Link Checker", 1234567, or "link-check-test.yml". If you don't specify a workflow, GitHub CLI returns an interactive menu for you to choose a workflow.

    gh workflow run workflow

    If your workflow accepts inputs, GitHub CLI will prompt you to enter them. Alternatively, you can use -f or -F to add an input in key=value format. Use -F to read from a file.

    gh workflow run greet.yml -f name=mona -f greeting=hello -F data=@myfile.txt

    You can also pass inputs as JSON by using standard input.

    echo '{"name":"mona", "greeting":"hello"}' | gh workflow run greet.yml --json

    To run a workflow on a branch other than the repository's default branch, use the --ref flag.

    gh workflow run workflow --ref branch-name

    To view the progress of the workflow run, use the run watch subcommand and select the run from the interactive list.

    gh run watch

    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."