Validate GitLab CI/CD configuration
DETAILS: Tier: Free, Premium, Ultimate Offering: GitLab.com, Self-managed, GitLab Dedicated
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 extension for VS Code.
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:
- On the left sidebar, select Search or go to and find your project.
- Select Build > Pipeline editor.
- Select the Validate tab.
- Select Lint CI/CD sample.
- Paste a copy of the CI/CD configuration you want to check into the text box.
- Select Validate.
Simulate a pipeline
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:
- On the left sidebar, select Search or go to and find your project.
- Select Build > Pipeline editor.
- Select the Validate tab.
- Select Lint CI/CD sample.
- Paste a copy of the CI/CD configuration you want to check into the text box.
- Select Simulate pipeline creation for the default branch.
- Select Validate.