53 lines
1.3 KiB
Markdown
53 lines
1.3 KiB
Markdown
|
# Validate the .gitlab-ci.yml (API)
|
||
|
|
|
||
|
|
> [Introduced][ce-5953] 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|
|
||
|
|
|
||
|
|
```bash
|
||
|
|
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\"]}}"}'
|
||
|
|
```
|
||
|
|
|
||
|
|
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:
|
||
|
|
|
||
|
|
```json
|
||
|
|
{
|
||
|
|
"status": "valid",
|
||
|
|
"errors": []
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
* Invalid content:
|
||
|
|
|
||
|
|
```json
|
||
|
|
{
|
||
|
|
"status": "invalid",
|
||
|
|
"errors": [
|
||
|
|
"variables config should be a hash of key value pairs"
|
||
|
|
]
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
* Without the content attribute:
|
||
|
|
|
||
|
|
```json
|
||
|
|
{
|
||
|
|
"error": "content is missing"
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
[ce-5953]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/5953
|
||
|
|
|