2020-10-29 15:09:12 +00:00
---
2021-02-05 09:09:10 +00:00
stage: Verify
group: Pipeline Authoring
2022-09-21 21:13:33 +00:00
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments
2020-10-29 15:09:12 +00:00
---
2021-09-01 00:08:56 +00:00
2022-02-09 18:16:19 +00:00
# Validate GitLab CI/CD configuration **(FREE)**
2020-08-12 15:10:02 +00:00
2022-02-09 18:16:19 +00:00
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.
2020-08-12 15:10:02 +00:00
2022-02-09 18:16:19 +00:00
If you use the [pipeline editor ](pipeline_editor/index.md ), it verifies configuration
syntax automatically.
2020-08-12 15:10:02 +00:00
2022-02-09 18:16:19 +00:00
If you use VS Code, you can validate your CI/CD configuration with the
2021-10-28 12:10:22 +00:00
[GitLab Workflow VS Code extension ](../user/project/repository/vscode.md ).
2022-02-09 18:16:19 +00:00
## Check CI/CD syntax
2020-08-12 15:10:02 +00:00
2022-02-09 18:16:19 +00:00
The CI lint tool checks the syntax of GitLab CI/CD configuration, including
configuration added with the [`includes` keyword ](yaml/index.md#include ).
2020-08-12 15:10:02 +00:00
2022-02-09 18:16:19 +00:00
To check CI/CD configuration with the CI lint tool:
2020-08-12 15:10:02 +00:00
2022-09-14 18:12:48 +00:00
1. On the top bar, select **Main menu > Projects** and find your project.
2022-04-08 00:09:54 +00:00
1. On the left sidebar, select **CI/CD > Pipelines** .
2022-02-09 18:16:19 +00:00
1. In the top right, select **CI lint** .
1. Paste a copy of the CI/CD configuration you want to check into the text box.
1. Select **Validate** .
2020-08-12 15:10:02 +00:00
2022-02-09 18:16:19 +00:00
## Simulate a pipeline
2020-08-12 15:10:02 +00:00
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/229794) in GitLab 13.3.
2022-02-09 18:16:19 +00:00
You can simulate the creation of a GitLab CI/CD pipeline to find more complicated issues,
including problems with [`needs` ](yaml/index.md#needs ) and [`rules` ](yaml/index.md#rules )
configuration. A simulation runs as a Git `push` event on the default branch.
2020-08-12 15:10:02 +00:00
2022-02-09 18:16:19 +00:00
Prerequisites:
2020-08-12 15:10:02 +00:00
2022-02-09 18:16:19 +00:00
- You must have [permissions ](../user/permissions.md#project-members-permissions )
to create pipelines on this branch to validate with a simulation.
2020-08-12 15:10:02 +00:00
2022-02-09 18:16:19 +00:00
To simulate a pipeline:
2020-08-12 15:10:02 +00:00
2022-09-14 18:12:48 +00:00
1. On the top bar, select **Main menu > Projects** and find your project.
2022-04-08 00:09:54 +00:00
1. On the left sidebar, select **CI/CD > Pipelines** .
2022-02-09 18:16:19 +00:00
1. In the top right, select **CI lint** .
1. Paste a copy of the CI/CD configuration you want to check into the text box.
1. Select **Simulate pipeline creation for the default branch** .
1. Select **Validate** .