summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMarcia Ramos <virtua.creative@gmail.com>2019-04-02 14:30:51 +0100
committerMarcia Ramos <virtua.creative@gmail.com>2019-04-02 14:30:51 +0100
commit5a15519aae99df88e9b5799ae8b0714351169bec (patch)
treed11fcdb0a5cdf1a55f19257876454a64011aa640
parentecc145f5d7b6175cebcea5756e97496de1e2b911 (diff)
downloadgitlab-ce-docs-revamp-ci-variables.tar.gz
Rename doc headingsdocs-revamp-ci-variables
- Include "environment variables" - Reduce ambiguity
-rw-r--r--doc/ci/variables/README.md28
1 files changed, 14 insertions, 14 deletions
diff --git a/doc/ci/variables/README.md b/doc/ci/variables/README.md
index d020635fa9d..963facd4d90 100644
--- a/doc/ci/variables/README.md
+++ b/doc/ci/variables/README.md
@@ -2,7 +2,7 @@
table_display_block: true
---
-# GitLab CI/CD Variables
+# GitLab CI/CD environment variables
After a brief overview over the use of environment
variables, this document teaches you how to use GitLab CI/CD's
@@ -35,15 +35,15 @@ pipeline and commit IDs, and much more.
Predefined environment variables are the ones that GitLab
provides out of the box for the local environment of the Runner.
-GitLab reads the `.gitlab-ci.yml` file, sends the output to the
-Runner (which runs the script commands in a Docker container),
+GitLab reads the `.gitlab-ci.yml` file, sends the information to the
+Runner (which runs the script commands in an executor),
under which the variables are exposed.
For example, two jobs under the same pipeline can share the same
`CI_PIPELINE_ID` variable, but each one has its own `CI_JOB_ID`
variable.
-### Custom variables
+### Custom environment variables
When your use case requires a specific variable, you can
[set them up easily from the UI](#creating-your-custom-variable)
@@ -57,7 +57,7 @@ the need to specify the value itself.
To get started with environment variables in the scope of GitLab
CI/CD, let's go over a few examples.
-### Using predefined variables
+### Using predefined environment variables
To get started, choose one of the existing
[predefined variables](predefined_variables.md)
@@ -95,7 +95,7 @@ For GitLab.com users, the output will be `gitlab.io`. For your
private instance, the output will be whatever your sysadmin has
defined.
-### Creating a custom variable
+### Creating a custom environment variable
Assume you have something you want to repeat through your scripts
in GitLab CI/CD's configuration file. To keep this example simple,
@@ -143,7 +143,7 @@ internal, you can set the pipelines private from your [project's Pipelines
settings](../../user/project/pipelines/settings.md#visibility-of-pipelines).
Follow the discussion in issue [#13784][ce-13784] for masking the variables.
-### Syntax of variables in job scripts
+### Syntax of environment variables in job scripts
All variables are set as environment variables in the build environment, and
they are accessible with normal methods that are used to access such variables.
@@ -275,7 +275,7 @@ script:
- 'eval $LS_CMD' # will execute 'ls -al $TMP_DIR'
```
-### Group-level variables
+### Group-level environment variables
> Introduced in GitLab 9.4.
@@ -293,7 +293,7 @@ Any variables of [subgroups](../../user/group/subgroups/index.md) will be inheri
Once you set them, they will be available for all subsequent pipelines.
-## Priority of variables
+## Priority of environment variables
Variables of different types can take precedence over other
variables, depending on where they are defined.
@@ -324,7 +324,7 @@ about which variables are [not supported](where_variables_can_be_used.md).
## Advanced use
-### Protected variables
+### Protected environment variables
> Introduced in GitLab 9.3.
@@ -339,7 +339,7 @@ Protected variables can be added by going to your project's
Once you set them, they will be available for all subsequent pipelines.
-### Deployment variables
+### Deployment environment variables
> Introduced in GitLab 8.15.
@@ -352,7 +352,7 @@ the project services that you are using to learn which variables they define.
An example project service that defines deployment variables is the
[Kubernetes integration](../../user/project/clusters/index.md#deployment-variables).
-### Auto DevOps application variables
+### Auto DevOps environment variables
> [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/issues/49056) in GitLab 11.7.
@@ -369,7 +369,7 @@ CAUTION: **Caution:**
Variables with multiline values are not currently supported due to
limitations with the current Auto DevOps scripting environment.
-### Variables triggered manually
+### Environment variables triggered manually
> [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/issues/44059) in GitLab 10.8.
@@ -389,7 +389,7 @@ value you set for this specific pipeline:
![Manually overridden variable output](img/override_value_via_manual_pipeline_output.png)
-## Variables expressions
+## Environment variables expressions
> Introduced in GitLab 10.7.