From ff97de61df3ebbeea31e5fef833e8a477c13ab3c Mon Sep 17 00:00:00 2001 From: Achilleas Pipinellis Date: Thu, 17 Nov 2016 08:54:51 +0100 Subject: [PATCH] Move name rules under environment:name in yaml readme --- doc/ci/yaml/README.md | 43 ++++++++++++++++++++++--------------------- 1 file changed, 22 insertions(+), 21 deletions(-) diff --git a/doc/ci/yaml/README.md b/doc/ci/yaml/README.md index 5c0e1c44e3f..bc9c0897f5a 100644 --- a/doc/ci/yaml/README.md +++ b/doc/ci/yaml/README.md @@ -552,6 +552,28 @@ An example usage of manual actions is deployment to production. If `environment` is specified and no environment under that name exists, a new one will be created automatically. +In its simplest form, the `environment` keyword can be defined like: + +``` +deploy to production: + stage: deploy + script: git push production HEAD:master + environment: + name: production +``` + +In the above example, the `deploy to production` job will be marked as doing a +deployment to the `production` environment. + +#### environment:name + +> Introduced in GitLab 8.11. + +>**Note:** +Before GitLab 8.11, the name of an environment could be defined as a string like +`environment: production`. The recommended way now is to define it under the +`name` keyword. + The `environment` name can contain: - letters @@ -567,27 +589,6 @@ The `environment` name can contain: Common names are `qa`, `staging`, and `production`, but you can use whatever name works with your workflow. -In its simplest form, the `environment` keyword can be defined like: - -``` -deploy to production: - stage: deploy - script: git push production HEAD:master - environment: production -``` - -In the above example, the `deploy to production` job will be marked as doing a -deployment to the `production` environment. - -#### environment:name - -> Introduced in GitLab 8.11. - ->**Note:** -Before GitLab 8.11, the name of an environment could be defined as a string like -`environment: production`. The recommended way now is to define it under the -`name` keyword. - Instead of defining the name of the environment right after the `environment` keyword, it is also possible to define it as a separate value. For that, use the `name` keyword under `environment`: