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
f5b733eb
Commit
f5b733eb
authored
Aug 21, 2017
by
Zeger-Jan van de Weg
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Fix broken links in documentation
Also, move the old linting docs to the new location.
parent
1ffd0c85
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
53 additions
and
6 deletions
+53
-6
doc/api/README.md
doc/api/README.md
+1
-6
doc/api/lint.md
doc/api/lint.md
+52
-0
No files found.
doc/api/README.md
View file @
f5b733eb
...
...
@@ -55,15 +55,10 @@ following locations:
-
[
Tags
](
tags.md
)
-
[
Todos
](
todos.md
)
-
[
Users
](
users.md
)
-
[
Validate CI configuration
](
ci/
lint.md
)
-
[
Validate CI configuration
](
lint.md
)
-
[
V3 to V4
](
v3_to_v4.md
)
-
[
Version
](
version.md
)
The following documentation is for the
[
internal CI API
](
ci/README.md
)
:
-
[
Builds
](
ci/builds.md
)
-
[
Runners
](
ci/runners.md
)
## Road to GraphQL
Going forward, we will start on moving to
...
...
doc/api/lint.md
0 → 100644
View file @
f5b733eb
# 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
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