Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
Boxiang Sun
gitlab-ce
Commits
ced7cf7b
Commit
ced7cf7b
authored
Sep 05, 2016
by
Katarzyna Kobierska
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Improve documentation
parent
25ece82d
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
65 additions
and
24 deletions
+65
-24
doc/api/ci/lint.md
doc/api/ci/lint.md
+65
-24
No files found.
doc/api/ci/lint.md
View file @
ced7cf7b
# Validate the .gitlab-ci.yml
> [Introduced][ce-5953] in GitLab 8.12.
Check whether your .gitlab-ci.yml file is valid.
```
...
...
@@ -11,35 +13,74 @@ POST ci/lint
|
`content`
| hash | yes | the .gitlab-ci.yaml content|
```
bash
curl
--request
POST
"https://gitlab.example.com/api/v3/ci/lint?content=YAML+Content"
curl
--request
POST
"https://gitlab.example.com/api/v3/ci/lint?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
"]
},
spinach: {
script: "
rake spinach
",
allow_failure: true,
tags: ["
ruby
", "
mysql
"],
except: ["
tags
"]
},
staging: {
variables: {KEY1: "
value1
", KEY2: "
value2
"},
script: "
cap deploy stating
",
type: "
deploy
",
tags: ["
ruby
", "
mysql
"],
except: ["
stable
"]
},
production: {
variables: {DB_NAME: "
mysql
"},
type: "
deploy
",
script: ["
cap deploy production
", "
cap notify
"],
tags: ["
ruby
", "
mysql
"],
only: ["
master
", "
/^deploy-.
*
$/
"]
},
dockerhub: {
type: "
notify
",
script: "
curl http://dockerhub/URL
",
tags: ["
ruby
", "
postgres
"],
only: ["
branches
"]
}
}"
```
Example response:
Be sure to copy paste the exact contents of
`.gitlab-ci.yml`
as YAML is very picky with indentation and spaces.
*
valid content
Example responses:
```
json
{
"status"
:
"valid"
,
"errors"
:
[]
}
```
*
Valid content:
*
invalid content
```json
{
"status": "valid",
"errors": []
}
```
```
json
{
"status"
:
"invalid"
,
"errors"
:
[
"variables config should be a hash of key value pairs"
]
}
```
*
Invalid content:
*
without the content attribute
```json
{
"status": "invalid",
"errors": [
"variables config should be a hash of key value pairs"
]
}
```
```
json
{
"error"
:
"content is missing"
}
```
*
Without the content attribute:
```json
{
"error": "content is missing"
}
```
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment