From 84827c1387a66970cbbbec28ae7ea56e9e4fa01e Mon Sep 17 00:00:00 2001 From: Grzegorz Bizon Date: Fri, 1 Sep 2017 13:42:10 +0200 Subject: Add some basic docs about kubernetes: active feature --- doc/ci/yaml/README.md | 35 +++++++++++++++++++++++++++++++---- 1 file changed, 31 insertions(+), 4 deletions(-) (limited to 'doc') diff --git a/doc/ci/yaml/README.md b/doc/ci/yaml/README.md index abf4ec7dbf8..eaf2c557a1e 100644 --- a/doc/ci/yaml/README.md +++ b/doc/ci/yaml/README.md @@ -427,16 +427,16 @@ a "key: value" pair. Be careful when using special characters: are executed in `parallel`. For more info about the use of `stage` please check [stages](#stages). -### only and except +### only and except (simplified) -`only` and `except` are two parameters that set a refs policy to limit when -jobs are built: +`only` and `except` are two parameters that set a job policy to limit when +jobs are created: 1. `only` defines the names of branches and tags for which the job will run. 2. `except` defines the names of branches and tags for which the job will **not** run. -There are a few rules that apply to the usage of refs policy: +There are a few rules that apply to the usage of job policy: * `only` and `except` are inclusive. If both `only` and `except` are defined in a job specification, the ref is filtered by `only` and `except`. @@ -497,6 +497,33 @@ job: The above example will run `job` for all branches on `gitlab-org/gitlab-ce`, except master. +### only and except (complex) + +> Introduced in GitLab 10.0 + +Since GitLab 10.0 it is possible to define a complex only/except job policy +configuration. + +GitLab now supports both, simple and complex strategies, so it is possible to +use array and hash scheme configuration. + +Two keys are now available: `refs` and `kubernetes`. Refs strategy equals to +simplified only/except configuration, whereas kubernetes strategy accepts only +`active` keyword. + +See the example below. Job is going to be created only when pipeline has been +scheduled or runs for a `master` branch, and only if kubernetes service is +active in the project. + +```yaml +job: + only: + refs: + - master + - schedules + kubernetes: active +``` + ### Job variables It is possible to define job variables using a `variables` keyword on a job -- cgit v1.2.3 From f911dafe6621c9735a11c6289bc1ef62a302cd7a Mon Sep 17 00:00:00 2001 From: Grzegorz Bizon Date: Fri, 1 Sep 2017 13:44:15 +0200 Subject: Add disclaimer about alpha kubernetes: active feature --- doc/ci/yaml/README.md | 1 + 1 file changed, 1 insertion(+) (limited to 'doc') diff --git a/doc/ci/yaml/README.md b/doc/ci/yaml/README.md index eaf2c557a1e..b281ff386bd 100644 --- a/doc/ci/yaml/README.md +++ b/doc/ci/yaml/README.md @@ -500,6 +500,7 @@ except master. ### only and except (complex) > Introduced in GitLab 10.0 +> This an _alpha_ feature, and it it subject to change at any time without prior notice! Since GitLab 10.0 it is possible to define a complex only/except job policy configuration. -- cgit v1.2.3 From ab8e6c802803dcbfb2624742d79439718deb1956 Mon Sep 17 00:00:00 2001 From: Grzegorz Bizon Date: Fri, 1 Sep 2017 13:47:58 +0200 Subject: Copy-edit kubernetes: active feature docs --- doc/ci/yaml/README.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) (limited to 'doc') diff --git a/doc/ci/yaml/README.md b/doc/ci/yaml/README.md index b281ff386bd..bcf5b5d0b5f 100644 --- a/doc/ci/yaml/README.md +++ b/doc/ci/yaml/README.md @@ -500,13 +500,14 @@ except master. ### only and except (complex) > Introduced in GitLab 10.0 -> This an _alpha_ feature, and it it subject to change at any time without prior notice! +> This an _alpha_ feature, and it it subject to change at any time without + prior notice! -Since GitLab 10.0 it is possible to define a complex only/except job policy -configuration. +Since GitLab 10.0 it is possible to define a more elaborate only/except job +policy configuration. GitLab now supports both, simple and complex strategies, so it is possible to -use array and hash scheme configuration. +use an array and a hash configuration scheme. Two keys are now available: `refs` and `kubernetes`. Refs strategy equals to simplified only/except configuration, whereas kubernetes strategy accepts only -- cgit v1.2.3 From 2c5a4cf571a1ee3c7f09c4fc853d609f7e1c826d Mon Sep 17 00:00:00 2001 From: Grzegorz Bizon Date: Fri, 1 Sep 2017 11:51:05 +0000 Subject: Fix only/except docs disclaimer's markdown --- doc/ci/yaml/README.md | 1 + 1 file changed, 1 insertion(+) (limited to 'doc') diff --git a/doc/ci/yaml/README.md b/doc/ci/yaml/README.md index bcf5b5d0b5f..cacfd2ed254 100644 --- a/doc/ci/yaml/README.md +++ b/doc/ci/yaml/README.md @@ -500,6 +500,7 @@ except master. ### only and except (complex) > Introduced in GitLab 10.0 + > This an _alpha_ feature, and it it subject to change at any time without prior notice! -- cgit v1.2.3