GitLab Pipeline trigger action

GitHub | GitHub Marketplace

This GitHub action triggers and waits for a GitLab pipeline to complete.

You can for example use this action in your GitHub workflow to trigger a deployment pipeline on a private GitLab server after a successful build pipeline and wait for the deployment (with possible End2End tests) to finish, so you would get a notification if the deployment failed.

sequenceDiagram
    participant GITHUB as GitHub Actions
    participant ACTION as Action
    participant GITLAB as GitLab CI

    GITHUB->>ACTION: Run action
    ACTION->>GITLAB: Trigger a new pipeline

loop Every 15 seconds
    ACTION->>GITLAB: Poll pipeline status
    GITLAB-->>ACTION: Current pipeline status
end

    ACTION-->>GITHUB: Final pipeline status

Inputs

host

The GitLab host to trigger the pipeline on. Default gitlab.com.

id

Required The ID or path of the project owned by the authenticated user. You will find the Project ID in the General Settings of your GitLab project.

ref

Required The branch or tag to run the pipeline on.

trigger_token

Required The GitLab pipeline trigger token to trigger the pipeline.

access_token

The GitLab pipeline access token to access the pipeline via the API. You need the read_api and read_repository scopes with Reporter role for this token.

For public projects you don't need to provide an access token.

variables

A map of key-valued strings containing the pipeline variables. For example: { VAR1: "value1", VAR2: "value2" }. The value has to be valid JSON. If not set the default is {}.

Outputs

status

The last status of the pipeline. See GitLab project pipelines for more information about which status values there are.

web_url

The URL of the pipeline, for example https://gitlab.com/foo/bar/pipelines/47.

Example usage

uses: digital-blueprint/gitlab-pipeline-trigger-action@v1
with:
  host: 'gitlab.example.com'
  trigger_token: ${{ secrets.DEPLOY_TRIGGER_TOKEN }}
  access_token: ${{ secrets.DEPLOY_ACCESS_TOKEN }}
  id: '123'
  ref: 'main'
  variables: '{"VAR1":"value1","VAR2":"value2"}'