BigW Consortium Gitlab

lint.md 1.25 KB
Newer Older
1
# Validate the .gitlab-ci.yml
2

3 4
> [Introduced][ce-5953] in GitLab 8.12.

5
Checks if your .gitlab-ci.yml file is valid.
6 7 8 9 10 11 12

```
POST ci/lint
```

| Attribute  | Type    | Required | Description |
| ---------- | ------- | -------- | -------- |
13
| `content`  | string    | yes      | the .gitlab-ci.yaml content|
14 15

```bash
16
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\"]}}"}'
17 18
```

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

21
Example responses:
22

23
* Valid content:
24

25 26 27 28 29 30
    ```json
    {
      "status": "valid",
      "errors": []
    }
    ```
31

32
* Invalid content:
33

34 35 36 37 38 39 40 41
    ```json
    {
      "status": "invalid",
      "errors": [
        "variables config should be a hash of key value pairs"
      ]
    }
    ```
42

43 44 45 46 47 48 49
* Without the content attribute:

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