View as Markdown

GitHub Actions (Deprecated)

Dispatch an existing GitHub workflow in the repository. Deprecated in favor of GitHub Actions events.

The github_actions action enables Mergify to dispatch existing GitHub workflows within a repository when specified conditions are satisfied.

Parameters

Section titled Parameters
workflow#

Workflow Action

Workflow Action

Section titled Workflow Action
dispatch#list of Workflow Action Dispatch

The list of workflows to dispatch via the action.

Workflow Action Dispatch

Section titled Workflow Action Dispatch
inputs#map of integer, boolean or Workflow input template

The inputs passed to your workflow execution if any. Values can be either a template, a number or a Boolean.

ref#string or null·defaultnull

The reference to use when triggering the job. If none is passed, the default repository branch is used.

workflow#string

The GitHub Workflow file name with its extension (e.g. ci.yml), or the numeric workflow id.

Examples

Section titled Examples

Dispatching GitHub Workflows with Inputs

Section titled Dispatching GitHub Workflows with Inputs

To dispatch three workflows named foo_workflow.yaml, hello_world_workflow.yaml and dynamic_workflow.yaml when a pull request is labeled with “dispatch”, use the following rule.

Here, the hello_world_workflow.yaml workflow accepts two inputs, which are defined as name and age. The dynamic_workflow.yaml takes the author input, set with variable substitution.

pull_request_rules:
  - name: Dispatch GitHub Actions
    conditions:
      - label = dispatch
    actions:
      github_actions:
        workflow:
          dispatch:
            - workflow: foo_workflow.yaml
            - workflow: hello_world_workflow.yaml
              inputs:
                name: steve
                age: 42
            - workflow: dynamic_workflow.yaml
              inputs:
                author: "{{ author }}"

Was this page helpful?

Edit this page on GitHub