summaryrefslogtreecommitdiff
path: root/doc/ci
diff options
context:
space:
mode:
authorAchilleas Pipinellis <axilleas@axilleas.me>2016-08-01 08:02:40 +0000
committerAchilleas Pipinellis <axilleas@axilleas.me>2016-08-01 08:02:40 +0000
commita5fdee61b6dd94cc6d0e87db59dcc7e554f0a796 (patch)
treecdf0ac7389319f9875353e7eb6552baea9f34f11 /doc/ci
parent2f344eca42f1f0fa8ac122316687bc166c489bf1 (diff)
parent3032e977170596eb1fd738211410fb2c57e7d81a (diff)
downloadgitlab-ce-a5fdee61b6dd94cc6d0e87db59dcc7e554f0a796.tar.gz
Merge branch 'document-yaml-colon' into 'master'
Clarify CI script needing to quote colons ## What does this MR do? Clarifies documentation for `.gitlab-ci.yml` `script`. ## Are there points in the code the reviewer needs to double check? Should this be a note? Is there a link to YAML spec we can point to? ## Why was this MR needed? ## What are the relevant issue numbers? Closes #20177. ## Screenshots (if relevant) See merge request !5481
Diffstat (limited to 'doc/ci')
-rw-r--r--doc/ci/yaml/README.md2
1 files changed, 2 insertions, 0 deletions
diff --git a/doc/ci/yaml/README.md b/doc/ci/yaml/README.md
index ea3fff1596e..01d71088543 100644
--- a/doc/ci/yaml/README.md
+++ b/doc/ci/yaml/README.md
@@ -379,6 +379,8 @@ job:
- bundle exec rspec
```
+Sometimes, `script` commands will need to be wrapped in single or double quotes. For example, commands that contain a colon (`:`) need to be wrapped in quotes so that the YAML parser knows to interpret the whole thing as a string rather than a "key: value" pair. Be careful when using special characters (`:`, `{`, `}`, `[`, `]`, `,`, `&`, `*`, `#`, `?`, `|`, `-`, `<`, `>`, `=`, `!`, `%`, `@`, `` ` ``).
+
### stage
`stage` allows to group build into different stages. Builds of the same `stage`