Validate GitLab CI/CD configuration
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab 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.
Docs
Edit this page to fix an error or add an improvement in a merge request.
Create an issue to suggest an improvement to this page.
Product
Create an issue if there's something you don't like about this feature.
Propose functionality by submitting a feature request.
Feature availability and product trials
View pricing to see all GitLab tiers and features, or to upgrade.
Try GitLab for free with access to all features for 30 days.
Get help
If you didn't find what you were looking for, search the docs.
If you want help with something specific and could use community support, post on the GitLab forum.
For problems setting up or using this feature (depending on your GitLab subscription).
Request support