Validate GitLab CI/CD configuration

Use the CI Lint tool to check the validity of GitLab CI/CD configuration. You can validate the syntax from a .gitlab-ci.yml file or any other sample CI/CD configuration. This tool checks for syntax and logic errors, and can simulate pipeline creation to try to find more complicated configuration problems.

If you use the pipeline editor, it verifies configuration syntax automatically.

If you use VS Code, you can validate your CI/CD configuration with the GitLab Workflow VS Code extension.

Check CI/CD syntax

The CI lint tool checks the syntax of GitLab CI/CD configuration, including configuration added with the includes keyword.

To check CI/CD configuration with the CI lint tool:

  1. On the top bar, select Main menu > Projects and find your project.
  2. On the left sidebar, select CI/CD > Pipelines.
  3. In the upper right, select CI lint.
  4. Paste a copy of the CI/CD configuration you want to check into the text box.
  5. Select Validate.

Simulate a pipeline

Introduced in GitLab 13.3.

You can simulate the creation of a GitLab CI/CD pipeline to find more complicated issues, including problems with needs and rules configuration. A simulation runs as a Git push event on the default branch.

Prerequisites:

  • You must have permissions to create pipelines on this branch to validate with a simulation.

To simulate a pipeline:

  1. On the top bar, select Main menu > Projects and find your project.
  2. On the left sidebar, select CI/CD > Pipelines.
  3. In the upper right, select CI lint.
  4. Paste a copy of the CI/CD configuration you want to check into the text box.
  5. Select Simulate pipeline creation for the default branch.
  6. Select Validate.