Validate the .gitlab-ci.yml
(API)
Introduced in GitLab 8.12.
Checks if your .gitlab-ci.yml
file is valid.
POST /ci/lint
Attribute | Type | Required | Description |
---|---|---|---|
content
| string | yes | the .gitlab-ci.yaml content
|
curl --header "Content-Type: application/json" https://gitlab.example.com/api/v4/ci/lint --data '{"content": "{ \"image\": \"ruby:2.6\", \"services\": [\"postgres\"], \"before_script\": [\"bundle install\", \"bundle exec rake db:create\"], \"variables\": {\"DB_NAME\": \"postgres\"}, \"types\": [\"test\", \"deploy\", \"notify\"], \"rspec\": { \"script\": \"rake spec\", \"tags\": [\"ruby\", \"postgres\"], \"only\": [\"branches\"]}}"}'
Be sure to copy paste the exact contents of .gitlab-ci.yml
as YAML is very picky about indentation and spaces.
Example responses:
-
Valid content:
{ "status": "valid", "errors": [] }
-
Invalid content:
{ "status": "invalid", "errors": [ "variables config should be a hash of key value pairs" ] }
-
Without the content attribute:
{ "error": "content is missing" }
Help and feedback
If there's something you don't like about this feature
To propose functionality that GitLab does not yet offer
To further help GitLab in shaping new features
If you didn't find what you were looking for
If you want help with something very specific to your use case, and can use some community support
POST ON GITLAB FORUM
If you have problems setting up or using this feature (depending on your GitLab subscription)
REQUEST SUPPORT
To view all GitLab tiers and features or to upgrade
If you want to try all features available in GitLab.com
If you want to try all features available in GitLab self-managed
If you spot an error or a need for improvement and would like to fix it yourself in a merge request
EDIT THIS PAGE
If you would like to suggest an improvement to this doc