summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCody Mize <me@codymize.com>2019-04-03 04:33:55 +0000
committerEvan Read <eread@gitlab.com>2019-04-03 04:33:55 +0000
commit00f112157009ab178983beb1ebbea6f890442796 (patch)
tree9dd57337f6a891823bff79da4121fc5ae406e129
parentccdf7a93905bb7fd5eb4be5772160a9fad8e19a4 (diff)
downloadgitlab-ce-00f112157009ab178983beb1ebbea6f890442796.tar.gz
Document matching refs with an at-symbol
At-symbols are used to match a ref to a specific repository path. Currently this is done by string splitting the ref pattern on the at-symbol. In order to pattern match a literal `@` you must use ruby's unicode character matching `\u{0040}`.
-rw-r--r--doc/ci/yaml/README.md5
1 files changed, 5 insertions, 0 deletions
diff --git a/doc/ci/yaml/README.md b/doc/ci/yaml/README.md
index 5690729c370..83a226d3577 100644
--- a/doc/ci/yaml/README.md
+++ b/doc/ci/yaml/README.md
@@ -391,6 +391,11 @@ job:
The above example will run `job` for all branches on `gitlab-org/gitlab-ce`,
except `master` and those with names prefixed with `release/`.
+NOTE: **Note:**
+Because `@` is used to denote the beginning of a ref's repository path,
+matching a ref name containing the `@` character in a regular expression
+requires the use of the hex character code match `\x40`.
+
If a job does not have an `only` rule, `only: ['branches', 'tags']` is set by
default. If it doesn't have an `except` rule, it is empty.