gitlab-org--gitlab-foss/doc/api/ci/lint.md

50 lines
1.3 KiB
Markdown
Raw Normal View History

2016-09-01 07:49:34 -04:00
# Validate the .gitlab-ci.yml
2016-08-31 05:16:25 -04:00
2016-09-05 05:06:16 -04:00
> [Introduced][ce-5953] in GitLab 8.12.
2016-09-05 07:51:33 -04:00
Checks if your .gitlab-ci.yml file is valid.
2016-08-31 05:16:25 -04:00
```
POST ci/lint
```
| Attribute | Type | Required | Description |
| ---------- | ------- | -------- | -------- |
2016-09-07 06:19:36 -04:00
| `content` | string | yes | the .gitlab-ci.yaml content|
2016-08-31 05:16:25 -04:00
```bash
2017-03-01 12:39:40 -05:00
curl --header "Content-Type: application/json" https://gitlab.example.com/api/v4/ci/lint --data '{"content": "{ \"image\": \"ruby:2.1\", \"services\": [\"postgres\"], \"before_script\": [\"gem install bundler\", \"bundle install\", \"bundle exec rake db:create\"], \"variables\": {\"DB_NAME\": \"postgres\"}, \"types\": [\"test\", \"deploy\", \"notify\"], \"rspec\": { \"script\": \"rake spec\", \"tags\": [\"ruby\", \"postgres\"], \"only\": [\"branches\"]}}"}'
2016-08-31 05:16:25 -04:00
```
2016-09-05 07:51:33 -04:00
Be sure to copy paste the exact contents of `.gitlab-ci.yml` as YAML is very picky about indentation and spaces.
2016-08-31 05:16:25 -04:00
2016-09-05 05:06:16 -04:00
Example responses:
2016-08-31 05:16:25 -04:00
2016-09-05 05:06:16 -04:00
* Valid content:
2016-08-31 05:16:25 -04:00
2016-09-05 05:06:16 -04:00
```json
{
"status": "valid",
"errors": []
}
```
2016-08-31 05:16:25 -04:00
2016-09-05 05:06:16 -04:00
* Invalid content:
2016-08-31 05:16:25 -04:00
2016-09-05 05:06:16 -04:00
```json
{
"status": "invalid",
"errors": [
"variables config should be a hash of key value pairs"
]
}
```
2016-08-31 05:16:25 -04:00
2016-09-05 05:06:16 -04:00
* Without the content attribute:
```json
{
"error": "content is missing"
}
```