lint.md 1.3 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
# 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
16
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\"]}}"}'
17 18 19 20 21 22
```

Be sure to copy paste the exact contents of `.gitlab-ci.yml` as YAML is very picky about indentation and spaces.

Example responses:

23
- Valid content:
24 25 26 27 28 29 30 31

    ```json
    {
      "status": "valid",
      "errors": []
    }
    ```

32
- Invalid content:
33 34 35 36 37 38 39 40 41 42

    ```json
    {
      "status": "invalid",
      "errors": [
        "variables config should be a hash of key value pairs"
      ]
    }
    ```

43
- Without the content attribute:
44 45 46 47 48 49 50 51

    ```json
    {
      "error": "content is missing"
    }
    ```

[ce-5953]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/5953