kotovalexarian-likes-gitlab/gitlab-org--gitlab-foss
1
0
Fork 0
Code Releases Activity
gitlab-org--gitlab-foss/doc/api/lint.md
Marcel Amirault 5abfc57ec3 Fix spacing of code blocks 
Code blocks should not be spaced 4 times, as this will
prevent the code from being colored. They should
also be spaced the same as the lists they are a part
of, to make reading easier.
2019-07-09 07:16:17 +00:00

1.3 KiB
Raw Blame History

Validate the .gitlab-ci.yml (API)

Introduced in GitLab 8.12.

Checks if your .gitlab-ci.yml file is valid.

POST /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"
}