Skip to content

帮
帮助文档

GitCode / 帮助文档

通知 1458
Star 123
Fork 137
帮
帮助文档

variables · 变更

页面历史
update file 编写于 作者: BaiXuePrincess's avatar BaiXuePrincess
隐藏空白更改
内联 并排
Showing with 52 addition and 58 deletion
docs/ci/variables.md
View page @ 865aa308
...@@ -4,7 +4,7 @@ ...@@ -4,7 +4,7 @@
环境变量是进程在其中运行的环境的一部分。 例如，正在运行的进程可以查询`TEMP`环境变量的值以发现合适的位置来存储临时文件，或者为可以在不同脚本中重用的数据库定义`URL` 。 环境变量是进程在其中运行的环境的一部分。 例如，正在运行的进程可以查询`TEMP`环境变量的值以发现合适的位置来存储临时文件，或者为可以在不同脚本中重用的数据库定义`URL` 。
变量对于在 CODECHINA CI/CD 中自定义作业很有用。 使用变量时，不必对值进行硬编码。 变量对于在 CODECHINA CI/CD 中自定义流水线任务很有用。 使用变量时，不必对值进行硬编码。
> 有关 CODECHINA CI/CD 高级使用的更多信息： > 有关 CODECHINA CI/CD 高级使用的更多信息：
> >
...@@ -13,7 +13,7 @@ ...@@ -13,7 +13,7 @@
## 预定义的 CI/CD 变量[](#predefined-environment-variables "Permalink") ## 预定义的 CI/CD 变量[](#predefined-environment-variables "Permalink")
CODECHINA CI/CD 具有一组[默认的预定义变量](predefined_variables.html) ，您可以使用它们而无需任何其他说明。 您可以调用问题编号、用户名、分支名称、流水线和提交 ID 等。 CODECHINA CI/CD 具有一组[默认的预定义变量](predefined_variables.html) ，你可以使用它们而无需任何其他说明。 你可以调用问题编号、用户名、分支名称、流水线和提交 ID 等。
CODECHINA 为 Runner 的本地环境提供了预定义的变量。 CODECHINA 为 Runner 的本地环境提供了预定义的变量。
...@@ -21,11 +21,11 @@ CODECHINA 读取`.codechina-ci.yml`文件，并将信息发送到 runner，在 ...@@ -21,11 +21,11 @@ CODECHINA 读取`.codechina-ci.yml`文件，并将信息发送到 runner，在
### 使用预定义的 CI/CD 变量[](#use-predefined-environment-variables "Permalink") ### 使用预定义的 CI/CD 变量[](#use-predefined-environment-variables "Permalink")
您可以选择现有的预定义变量之一，以由 Runner 输出。 你可以选择现有的预定义变量之一，以由 Runner 输出。
本示例说明如何使用预定义变量`CI_JOB_STAGE`输出流水线任务的 stage。 本示例说明如何使用预定义变量`CI_JOB_STAGE`输出流水线任务的 stage。
在您的`.codechina-ci.yml`文件中，从脚本中调用变量。 确保使用正确的[语法](#syntax-of-environment-variables-in-job-scripts) 。 在你的`.codechina-ci.yml`文件中，从脚本中调用变量。 确保使用正确的[语法](#syntax-of-environment-variables-in-job-scripts) 。
``` ```
test_variable: test_variable:
...@@ -38,7 +38,7 @@ test_variable: ...@@ -38,7 +38,7 @@ test_variable:
[![Output `$CI_JOB_STAGE`](img/b6a9c5aa2e348263baf61cb961ac802f.png)](img/ci_job_stage_output_example.png) [![Output `$CI_JOB_STAGE`](img/b6a9c5aa2e348263baf61cb961ac802f.png)](img/ci_job_stage_output_example.png)
再举一个例子，假设您使用自己的 GitLab 实例，并且想知道 GitLab 页面在哪个域下提供服务。 您可以通过在脚本中使用预定义变量`$CI_PAGES_DOMAIN`来调用它： 再举一个例子，假设你使用自己的 CODECHINA 实例，并且想知道 CODECHINA 页面在哪个域下提供服务。 你可以通过在脚本中使用预定义变量`$CI_PAGES_DOMAIN`来调用它：
``` ```
pages: pages:
...@@ -47,15 +47,15 @@ pages: ...@@ -47,15 +47,15 @@ pages:
- echo $CI_PAGES_DOMAIN - echo $CI_PAGES_DOMAIN
``` ```
对于 GitLab.com 用户，输出将为`gitlab.io` 。 对于您的私有实例，输出将是您的系统管理员定义的任何内容。 对于 GitLab.com 用户，输出将为`gitlab.io` 。 对于你的私有实例，输出将是你的系统管理员定义的任何内容。
## 自定义 CI/CD 变量[](#custom-environment-variables "Permalink") ## 自定义 CI/CD 变量[](#custom-environment-variables "Permalink")
当需要特定的自定义环境变量时，可以[在 UI](#create-a-custom-variable-in-the-ui)、[API](../../api/project_level_variables.html)或直接[在`.codechina-ci.yml`文件中进行设置](#create-a-custom-variable-in-gitlab-ciyml) 。 当需要特定的自定义环境变量时，可以[在 UI](#create-a-custom-variable-in-the-ui)、[API](../../api/project_level_variables.html)或直接[在`.codechina-ci.yml`文件中进行设置](#create-a-custom-variable-in-gitlab-ciyml) 。
每当流水线运行时，Runner 就会使用这些变量。 您还[可以手动覆盖特定流水线的变量值](../pipelines/index.html#specifying-variables-when-running-manual-jobs) 。 每当流水线运行时，Runner 就会使用这些变量。 你还[可以手动覆盖特定流水线的变量值](../pipelines/index.html#specifying-variables-when-running-manual-jobs) 。
变量有两种类型： **Variable**和**File** 。 您无法在`.codechina-ci.yml`文件中设置类型，但可以在 UI 和 API 中进行设置。 变量有两种类型： **Variable**和**File** 。 你无法在`.codechina-ci.yml`文件中设置类型，但可以在 UI 和 API 中进行设置。
### 在 `.codechina-ci.yml` 创建自定义变量[](#create-a-custom-variable-in-gitlab-ciyml "Permalink") ### 在 `.codechina-ci.yml` 创建自定义变量[](#create-a-custom-variable-in-gitlab-ciyml "Permalink")
...@@ -66,7 +66,7 @@ variables: ...@@ -66,7 +66,7 @@ variables:
TEST: "HELLO WORLD" TEST: "HELLO WORLD"
``` ```
然后，您可以在脚本中调用其值： 然后，你可以在脚本中调用其值：
``` ```
script: script:
...@@ -77,7 +77,7 @@ variables: ...@@ -77,7 +77,7 @@ variables:
### 在界面创建自定义变量[](#create-a-custom-variable-in-the-ui "Permalink") ### 在界面创建自定义变量[](#create-a-custom-variable-in-the-ui "Permalink")
在用户界面中，您可以添加或更新自定义环境变量： 在用户界面中，你可以添加或更新自定义环境变量：
1。 转到项目的**设置> CI/CD**，然后展开 **变量**部分。 1。 转到项目的**设置> CI/CD**，然后展开 **变量**部分。
2。 单击**添加变量**按钮。 在" **添加变量**模式"中，填写详细信息： 2。 单击**添加变量**按钮。 在" **添加变量**模式"中，填写详细信息：
...@@ -87,9 +87,9 @@ variables: ...@@ -87,9 +87,9 @@ variables:
* **类型**: `文件` or `变量`。 * **类型**: `文件` or `变量`。
* **环境范围** ： `全部`或特定环境。 * **环境范围** ： `全部`或特定环境。
* **保护变量** （可选）：如果选中，则该变量将仅在在受保护的分支或标签上运行的流水线中可用。 * **保护变量** （可选）：如果选中，则该变量将仅在在受保护的分支或标签上运行的流水线中可用。
* **隐藏变量** （可选）：如果选中，则变量的**值**将在作业日志中被隐藏。 如果该值不满足[隐藏要求，](#masked-variable-requirements)则变量将无法保存。 * **隐藏变量** （可选）：如果选中，则变量的**值**将在流水线任务日志中被隐藏。 如果该值不满足[隐藏要求，](#masked-variable-requirements)则变量将无法保存。
创建变量后，您可以通过点击 **编辑**按钮。 创建变量后，你可以通过点击 **编辑**按钮。
设置变量后，请从`.codechina-ci.yml`文件中调用它： 设置变量后，请从`.codechina-ci.yml`文件中调用它：
...@@ -111,13 +111,13 @@ test_variable: ...@@ -111,13 +111,13 @@ test_variable:
对于类型为**Variable 的变量** ，Runner 会创建一个环境变量，该环境变量将键用作名称，并将值用作值。 对于类型为**Variable 的变量** ，Runner 会创建一个环境变量，该环境变量将键用作名称，并将值用作值。
有一些这种类型的[预定义变量](#custom-variables-validated-by-gitlab) ，可以进一步验证。 它们在您在 UI 中添加或更新变量时出现。 有一些这种类型的[预定义变量](#custom-variables-validated-by-gitlab) ，可以进一步验证。 它们在你在 UI 中添加或更新变量时出现。
### 文件类型的自定义环境变量[](#custom-environment-variables-of-type-file "Permalink") ### 文件类型的自定义环境变量[](#custom-environment-variables-of-type-file "Permalink")
对于**文件**类型的变量，Runner 创建一个环境变量，该环境变量使用键作为名称。 对于该值，Runner 将变量值写入临时文件并使用此路径。 对于**文件**类型的变量，Runner 创建一个环境变量，该环境变量使用键作为名称。 对于该值，Runner 将变量值写入临时文件并使用此路径。
您可以使用诸如[AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-envvars.html)和[`kubectl`](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/#the-kubeconfig-environment-variable)类[的](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-envvars.html)工具通过使用**文件** 类型变量来自定义配置。 你可以使用诸如[AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-envvars.html)和[`kubectl`](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/#the-kubeconfig-environment-variable)类[的](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-envvars.html)工具通过使用**文件** 类型变量来自定义配置。
过去，常见的模式是读取 CI 变量的值，将其保存在文件中，然后在脚本中使用新创建的文件： 过去，常见的模式是读取 CI 变量的值，将其保存在文件中，然后在脚本中使用新创建的文件：
...@@ -128,12 +128,12 @@ echo "$KUBE_CA_PEM" > "$(pwd)/kube.ca.pem" ...@@ -128,12 +128,12 @@ echo "$KUBE_CA_PEM" > "$(pwd)/kube.ca.pem"
kubectl config set-cluster e2e --server="$KUBE_URL" --certificate-authority="$(pwd)/kube.ca.pem" kubectl config set-cluster e2e --server="$KUBE_URL" --certificate-authority="$(pwd)/kube.ca.pem"
``` ```
代替此，您可以使用**文件**类型变量。 例如，如果您具有以下变量： 代替此，你可以使用**文件**类型变量。 例如，如果你具有以下变量：
* 类型为**Variable** ： `KUBE_URL` **变量** ，其值为`https://example.com` 。 * 类型为**Variable** ： `KUBE_URL` **变量** ，其值为`https://example.com` 。
* 类型为**File** ： `KUBE_CA_PEM`变量，其值为证书。 * 类型为**File** ： `KUBE_CA_PEM`变量，其值为证书。
您可以从`.codechina-ci.yml`调用它们，如下所示： 你可以从`.codechina-ci.yml`调用它们，如下所示：
``` ```
kubectl config set-cluster e2e --server="$KUBE_URL" --certificate-authority="$KUBE_CA_PEM" kubectl config set-cluster e2e --server="$KUBE_URL" --certificate-authority="$KUBE_CA_PEM"
...@@ -141,13 +141,13 @@ kubectl config set-cluster e2e --server="$KUBE_URL" --certificate-authority="$KU ...@@ -141,13 +141,13 @@ kubectl config set-cluster e2e --server="$KUBE_URL" --certificate-authority="$KU
### 屏蔽自定义变量[](#mask-a-custom-variable "Permalink") ### 屏蔽自定义变量[](#mask-a-custom-variable "Permalink")
可以屏蔽变量，以便将变量的值隐藏在作业日志中。 可以屏蔽变量，以便将变量的值隐藏在流水线任务日志中。
要屏蔽变量： 要屏蔽变量：
1. 转到**设置> CI/CD** 。 1. 转到**设置> CI/CD** 。
2. 展开**变量**部分。 2. 展开**变量**部分。
3. 在您要保护的变量旁边，点击**编辑** 。 3. 在你要保护的变量旁边，点击**编辑** 。
4. 选择**掩码变量**复选框。 4. 选择**掩码变量**复选框。
5. 点击 **更新变量**。 5. 点击 **更新变量**。
...@@ -160,7 +160,7 @@ kubectl config set-cluster e2e --server="$KUBE_URL" --certificate-authority="$KU ...@@ -160,7 +160,7 @@ kubectl config set-cluster e2e --server="$KUBE_URL" --certificate-authority="$KU
* 不是预定义或自定义环境变量。 * 不是预定义或自定义环境变量。
* 仅由 Base64 字母（RFC4648）中的字符组成，`@`和`:`也是有效值。 * 仅由 Base64 字母（RFC4648）中的字符组成，`@`和`:`也是有效值。
您不能屏蔽不满足这些要求的变量。 你不能屏蔽不满足这些要求的变量。
### 保护自定义变量[](#protect-a-custom-variable "Permalink") ### 保护自定义变量[](#protect-a-custom-variable "Permalink")
...@@ -170,7 +170,7 @@ kubectl config set-cluster e2e --server="$KUBE_URL" --certificate-authority="$KU ...@@ -170,7 +170,7 @@ kubectl config set-cluster e2e --server="$KUBE_URL" --certificate-authority="$KU
1. 转到**设置> CI / CD** 。 1. 转到**设置> CI / CD** 。
2. 展开**变量**部分。 2. 展开**变量**部分。
3. 在您要保护的变量旁边，点击**编辑** 。 3. 在你要保护的变量旁边，点击**编辑** 。
4. 选择**保护变量**复选框。 4. 选择**保护变量**复选框。
5. Click **更新变量**。 5. Click **更新变量**。
...@@ -178,7 +178,7 @@ kubectl config set-cluster e2e --server="$KUBE_URL" --certificate-authority="$KU ...@@ -178,7 +178,7 @@ kubectl config set-cluster e2e --server="$KUBE_URL" --certificate-authority="$KU
### 由 GitLab 验证的自定义变量[](#custom-variables-validated-by-gitlab "Permalink") ### 由 GitLab 验证的自定义变量[](#custom-variables-validated-by-gitlab "Permalink")
UI 中列出了一些变量，因此您可以更快地选择它们。 GitLab 会验证这些变量的值，以确保它们的格式正确。 UI 中列出了一些变量，因此你可以更快地选择它们。 GitLab 会验证这些变量的值，以确保它们的格式正确。
| 变量 | 允许值 | | 变量 | 允许值 |
| --- | --- | --- | | --- | --- | --- |
...@@ -186,7 +186,7 @@ UI 中列出了一些变量，因此您可以更快地选择它们。 GitLab 会 ...@@ -186,7 +186,7 @@ UI 中列出了一些变量，因此您可以更快地选择它们。 GitLab 会
| `AWS_DEFAULT_REGION` | 任何 | | `AWS_DEFAULT_REGION` | 任何 |
| `AWS_SECRET_ACCESS_KEY` | 40 个字符：字母，数字，特殊字符 | | `AWS_SECRET_ACCESS_KEY` | 40 个字符：字母，数字，特殊字符 |
**注意：**存储凭据时，会涉及安全性。 例如，如果您使用的是 AWS 密钥，请遵循其[最佳做法](https://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html) 。 **注意：**存储凭据时，会涉及安全性。 例如，如果你使用的是 AWS 密钥，请遵循其[最佳做法](https://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html) 。
## 流水线任务脚本中环境变量的语法[](#syntax-of-environment-variables-in-job-scripts "Permalink") ## 流水线任务脚本中环境变量的语法[](#syntax-of-environment-variables-in-job-scripts "Permalink")
...@@ -222,7 +222,7 @@ job_name: ...@@ -222,7 +222,7 @@ job_name:
- echo $env:PATH - echo $env:PATH
``` ```
在[某些情况下，](https://gitlab.com/gitlab-org/gitlab-runner/-/issues/4115#note_157692820)环境变量可能需要用引号引起来才能正确扩展： 在某些情况下，环境变量可能需要用引号引起来才能正确扩展：
``` ```
job_name: job_name:
...@@ -242,7 +242,7 @@ job_name: ...@@ -242,7 +242,7 @@ job_name:
### 列出所有环境变量[](#list-all-environment-variables "Permalink") ### 列出所有环境变量[](#list-all-environment-variables "Permalink")
您还可以使用 Bash 中的`export`命令或 PowerShell 中的`dir env:`命令列出所有环境变量。 请注意，这还将在作业日志中公开您设置的所有变量的值： 你还可以使用 Bash 中的`export`命令或 PowerShell 中的`dir env:`命令列出所有环境变量。 请注意，这还将在流水线任务日志中公开你设置的所有变量的值：
``` ```
job_name: job_name:
...@@ -301,7 +301,7 @@ export GITLAB_USER_ID="42" ...@@ -301,7 +301,7 @@ export GITLAB_USER_ID="42"
## `.codechina-ci.yml` 定义的变量[](#gitlab-ciyml-defined-variables "Permalink") ## `.codechina-ci.yml` 定义的变量[](#gitlab-ciyml-defined-variables "Permalink")
您可以将在构建环境中设置的变量添加到`.codechina-ci.yml` 。 这些变量保存在仓库中，它们旨在存储非敏感项目配置，例如`RAILS_ENV`或`DATABASE_URL` 。 你可以将在构建环境中设置的变量添加到`.codechina-ci.yml` 。 这些变量保存在仓库中，它们旨在存储非敏感项目配置，例如`RAILS_ENV`或`DATABASE_URL` 。
例如，如果将变量全局设置为下方（而不是在流水线任务内部），它将在所有已执行的命令和脚本中使用： 例如，如果将变量全局设置为下方（而不是在流水线任务内部），它将在所有已执行的命令和脚本中使用：
...@@ -310,8 +310,6 @@ variables: ...@@ -310,8 +310,6 @@ variables:
DATABASE_URL: "postgres://postgres@postgres/my_database" DATABASE_URL: "postgres://postgres@postgres/my_database"
``` ```
还将 YAML 定义的变量设置为所有创建的[服务容器](../docker/using_docker_images.html) ，以便您可以对其进行微调。
变量可以在全局级别定义，也可以在流水线任务级别定义。 要在流水线任务中关闭全局定义的变量，请定义一个空哈希： 变量可以在全局级别定义，也可以在流水线任务级别定义。 要在流水线任务中关闭全局定义的变量，请定义一个空哈希：
``` ```
...@@ -319,7 +317,7 @@ job_name: ...@@ -319,7 +317,7 @@ job_name:
variables: {} variables: {}
``` ```
您可以在变量定义内使用其他变量（或使用`$$`对其进行转义）： 你可以在变量定义内使用其他变量（或使用`$$`对其进行转义）：
``` ```
variables: variables:
...@@ -331,7 +329,7 @@ script: ...@@ -331,7 +329,7 @@ script:
## 组级环境变量[](#group-level-environment-variables "Permalink") ## 组级环境变量[](#group-level-environment-variables "Permalink")
您可以定义在流水线环境中设置的每个项目或每个组的变量。 组级变量存储在仓库之外（不在`.codechina-ci.yml` ），并安全地传递到 CODECHINA Runner，这使它们在流水线运行期间可用。 你可以定义在流水线环境中设置的每个项目或每个组的变量。 组级变量存储在仓库之外（不在`.codechina-ci.yml` ），并安全地传递到 CODECHINA Runner，这使它们在流水线运行期间可用。
组级变量可以通过以下方式添加： 组级变量可以通过以下方式添加：
...@@ -351,7 +349,7 @@ script: ...@@ -351,7 +349,7 @@ script:
**注意：**实例级变量的最大数量为 25。 **注意：**实例级变量的最大数量为 25。
您可以通过 UI 或 API 定义实例级变量。 你可以通过 UI 或 API 定义实例级变量。
要添加实例级变量： 要添加实例级变量：
...@@ -361,14 +359,14 @@ script: ...@@ -361,14 +359,14 @@ script:
* **键** ：必须为一行，只能使用字母，数字或`_` （下划线），且不能有空格。 * **键** ：必须为一行，只能使用字母，数字或`_` （下划线），且不能有空格。
* **值** ：允许 10000 个字符。 * **值** ：允许 10000 个字符。
* **类型**: `File` or `Variable`。 * **类型**: `File` or `Variable`。
* **保护变量** （可选）：如果选中，则该变量将仅在在受保护的分支或标签上运行的管道中可用。 * **保护变量** （可选）：如果选中，则该变量将仅在在受保护的分支或标签上运行的流水线中可用。
* **屏蔽变量** （可选）：如果选中，则变量的**值**将不会显示在作业日志中。 如果该值不满足[屏蔽要求，](#masked-variable-requirements)则不会保存该变量。 * **屏蔽变量** （可选）：如果选中，则变量的**值**将不会显示在流水线任务日志中。 如果该值不满足[屏蔽要求，](#masked-variable-requirements)则不会保存该变量。
创建变量后，您可以通过点击 **编辑**按钮来更新任何详细信息。 创建变量后，你可以通过点击 **编辑**按钮来更新任何详细信息。
### 启用或禁用实例级 CI/CD 变量的 UI 界面[](#enable-or-disable-ui-interface-for-instance-level-cicd-variables "Permalink") ### 启用或禁用实例级 CI/CD 变量的 UI 界面[](#enable-or-disable-ui-interface-for-instance-level-cicd-variables "Permalink")
实例级 CI/CD 变量的 UI 界面正在开发中，但可用于生产环境。 它部署在**默认情况下启用**的功能标志的后面。 [有权访问 GitLab Rails 控制台的 GitLab 管理员](../../administration/feature_flags.html)可以选择为您的实例禁用它。 实例级 CI/CD 变量的 UI 界面正在开发中，但可用于生产环境。 它部署在**默认情况下启用**的功能标志的后面。 [有权访问 GitLab Rails 控制台的 GitLab 管理员](../../administration/feature_flags.html)可以选择为你的实例禁用它。
禁用它： 禁用它：
...@@ -384,7 +382,7 @@ Feature.enable(:instance_variables_ui) ...@@ -384,7 +382,7 @@ Feature.enable(:instance_variables_ui)
## 继承环境变量[](#inherit-environment-variables "Permalink") ## 继承环境变量[](#inherit-environment-variables "Permalink")
您可以从相关流水线任务中继承环境变量。 你可以从相关流水线任务中继承环境变量。
该功能利用了[`artifacts:reports:dotenv`](../pipelines/job_artifacts.html#artifactsreportsdotenv)报告功能。 该功能利用了[`artifacts:reports:dotenv`](../pipelines/job_artifacts.html#artifactsreportsdotenv)报告功能。
...@@ -433,53 +431,49 @@ deploy: ...@@ -433,53 +431,49 @@ deploy:
变量的优先顺序为（从最高到最低）： 变量的优先顺序为（从最高到最低）：
1. [触发器变量](../triggers/README.html#making-use-of-trigger-variables) ， [计划的流水线变量](../pipelines/schedules.html#using-variables)和[手动流水线运行变量](#override-a-variable-by-manually-running-a-pipeline) 。 1. 触发器变量， [计划的流水线变量](/docs/ci/pipelines/schedules.md#using-variables)和[手动流水线运行变量](#override-a-variable-by-manually-running-a-pipeline) 。
2. 项目级 [变量](#custom-environment-variables) 或[受保护变量](#protect-a-custom-variable)。 2. 项目级 [变量](#custom-environment-variables) 或[受保护变量](#protect-a-custom-variable)。
3. 组织级 [变量](#group-level-environment-variables)或[受保护变量](#protect-a-custom-variable)。 3. 组织级 [变量](#group-level-environment-variables)或[受保护变量](#protect-a-custom-variable)。
4. [继承环境变量](#inherit-environment-variables)。 4. [继承环境变量](#inherit-environment-variables)。
5. YAML定义的 [流水线任务级变量](../yaml/README.html#variables)。 5. YAML定义的 [流水线任务级变量](../yaml/README.html#variables)。
6. YAML定义的 [全局变量](../yaml/README.html#variables)。 6. YAML定义的 [全局变量](../yaml/README.html#variables)。
7. [部署变量](#deployment-environment-variables)。 7. [部署变量](#deployment-environment-variables)。
8. [预定义环境变量](predefined_variables.html)。 8. 预定义环境变量。
例如，如果您定义： 例如，如果你定义：
* `API_TOKEN=secure`作为项目变量。 * `API_TOKEN=secure`作为项目变量。
* `API_TOKEN=yaml`在您的`.codechina-ci.yml` 。 * `API_TOKEN=yaml`在你的`.codechina-ci.yml` 。
`API_TOKEN`将采用`secure`值，因为项目变量优先于`.codechina-ci.yml`中定义的变量。 `API_TOKEN`将采用`secure`值，因为项目变量优先于`.codechina-ci.yml`中定义的变量。
## 不支持的变量[](#unsupported-variables "Permalink") ## 不支持的变量[](#unsupported-variables "Permalink")
变量名称受用于执行脚本的底层 shell 的限制 (请参阅 [可用的 shell ](https://docs.gitlab.com/runner/shells/index.html))。 每个shell都有自己唯一的一组保留变量名。 您还需要记住环境变量的范围以确保在希望使用它的范围内定义变量。 变量名称受用于执行脚本的底层 shell 的限制 (请参阅 [可用的 shell ](https://docs.gitlab.com/runner/shells/index.html))。 每个shell都有自己唯一的一组保留变量名。 你还需要记住环境变量的范围以确保在希望使用它的范围内定义变量。
## 高级使用[](#advanced-use "Permalink") ## 高级使用[](#advanced-use "Permalink")
### 限制环境变量的环境范围[](#limit-the-environment-scopes-of-environment-variables "Permalink") ### 限制环境变量的环境范围[](#limit-the-environment-scopes-of-environment-variables "Permalink")
您可以通过[定义](../environments/index.html)变量可用于的环境来限制变量的环境范围。 你可以通过定义变量可用于的环境来限制变量的环境范围。
要了解有关范围界定环境的更多信息，请参阅[使用规范范围界定环境](../environments/index.html#scoping-environments-with-specs) 。
### 部署环境变量[](#deployment-environment-variables "Permalink") ### 部署环境变量[](#deployment-environment-variables "Permalink")
负责部署配置的[集成](../../user/project/integrations/overview.html)可以定义在构建环境中设置的自己的变量。 这些变量仅为[部署作业](../environments/index.html)定义。 请查阅所用集成的文档，以了解它们定义了哪些变量。 负责部署配置的集成可以定义在构建环境中设置的自己的变量。 这些变量仅为部署流水线任务定义。 请查阅所用集成的文档，以了解它们定义了哪些变量。
定义部署变量的示例集成是[Kubernetes 集成](../../user/project/clusters/index.html#deployment-variables) 。
### Auto DevOps 环境变量[](#auto-devops-environment-variables "Permalink") ### Auto DevOps 环境变量[](#auto-devops-environment-variables "Permalink")
您可以配置[Auto DevOps，](../../topics/autodevops/index.html)以将 CI 变量传递给正在运行的应用程序，方法是在变量的键之前添加`K8S_SECRET_` 。 你可以配置Auto DevOps，以将 CI 变量传递给正在运行的应用程序，方法是在变量的键之前添加`K8S_SECRET_` 。
然后，这些[前缀变量](../../topics/autodevops/customize.html#application-secret-variables)将在运行的应用程序容器上用作环境变量。 然后，这些前缀变量将在运行的应用程序容器上用作环境变量。
**警告：**由于当前 Auto DevOps 脚本环境的限制，当前不支持具有多行值的变量。 **警告：**由于当前 Auto DevOps 脚本环境的限制，当前不支持具有多行值的变量。
### 通过手动运行流水线覆盖变量[](#override-a-variable-by-manually-running-a-pipeline "Permalink") ### 通过手动运行流水线覆盖变量[](#override-a-variable-by-manually-running-a-pipeline "Permalink")
您可以通过[手动运行管道](/docs/ci/pipelines.md#run-a-pipeline-manually)来覆盖当前变量的值。 你可以通过[手动运行流水线](/docs/ci/pipelines.md#run-a-pipeline-manually)来覆盖当前变量的值。
例如，假设您添加了一个名为`$TEST`的自定义变量，并且想在手动流水线中覆盖它。 例如，假设你添加了一个名为`$TEST`的自定义变量，并且想在手动流水线中覆盖它。
导航到项目的**CI/CD> 流水线** ，然后单击**运行 流水线** 。 选择要为其运行流水线的分支，然后在 UI 中添加变量及其值： 导航到项目的**CI/CD> 流水线** ，然后单击**运行 流水线** 。 选择要为其运行流水线的分支，然后在 UI 中添加变量及其值：
...@@ -518,7 +512,7 @@ deploy: ...@@ -518,7 +512,7 @@ deploy:
### CI/CD 变量表达式的语法[](#syntax-of-environment-variable-expressions "Permalink") ### CI/CD 变量表达式的语法[](#syntax-of-environment-variable-expressions "Permalink")
您可以在下面找到受支持的语法参考： 你可以在下面找到受支持的语法参考：
1. 使用字符串进行相等匹配 1. 使用字符串进行相等匹配
...@@ -527,7 +521,7 @@ deploy: ...@@ -527,7 +521,7 @@ deploy:
* `$VARIABLE == "some value"` * `$VARIABLE == "some value"`
* `$VARIABLE != "some value"` * `$VARIABLE != "some value"`
您可以使用等于运算符`==`或`!=`将变量内容与字符串进行比较。 我们支持双引号和单引号来定义字符串值，因此同时支持`$VARIABLE == "some value"`和`$VARIABLE == 'some value'` 。 `"some value" == $VARIABLE`也正确。 你可以使用等于运算符`==`或`!=`将变量内容与字符串进行比较。 我们支持双引号和单引号来定义字符串值，因此同时支持`$VARIABLE == "some value"`和`$VARIABLE == 'some value'` 。 `"some value" == $VARIABLE`也正确。
2. 检查未定义的值 2. 检查未定义的值
...@@ -536,7 +530,7 @@ deploy: ...@@ -536,7 +530,7 @@ deploy:
* `$VARIABLE == null` * `$VARIABLE == null`
* `$VARIABLE != null` * `$VARIABLE != null`
有时，您可能想检查是否定义了变量。 为此，您可以将变量与`null`关键字进行比较，例如`$VARIABLE == null` 。 如果在使用`==`时未定义变量，则该表达式的值为 true；如果使用`!=`则该表达式的值为 false。 有时，你可能想检查是否定义了变量。 为此，你可以将变量与`null`关键字进行比较，例如`$VARIABLE == null` 。 如果在使用`==`时未定义变量，则该表达式的值为 true；如果使用`!=`则该表达式的值为 false。
3. 检查空变量 3. 检查空变量
...@@ -560,7 +554,7 @@ deploy: ...@@ -560,7 +554,7 @@ deploy:
例子: `$STAGING` 例子: `$STAGING`
如果只想在存在某个变量时创建作业，这意味着它是已定义且非空的，则可以简单地使用变量名作为表达式，例如`$STAGING` 。 如果`$STAGING`变量已定义且不为空，则表达式将求值为真。 `$STAGING`值必须是长度大于零的字符串。 仅包含空格字符的变量不是空变量。 如果只想在存在某个变量时创建流水线任务，这意味着它是已定义且非空的，则可以简单地使用变量名作为表达式，例如`$STAGING` 。 如果`$STAGING`变量已定义且不为空，则表达式将求值为真。 `$STAGING`值必须是长度大于零的字符串。 仅包含空格字符的变量不是空变量。
6. 模式匹配 6. 模式匹配
...@@ -603,7 +597,7 @@ deploy_staging: ...@@ -603,7 +597,7 @@ deploy_staging:
**注意：**可用的正则表达式语法受到限制。 **注意：**可用的正则表达式语法受到限制。
如果需要，您可以使用测试流水线来确定正则表达式是否可以在变量中工作。 下面的示例直接从变量内部测试`^mast.*`正则表达式： 如果需要，你可以使用测试流水线来确定正则表达式是否可以在变量中工作。 下面的示例直接从变量内部测试`^mast.*`正则表达式：
``` ```
variables: variables:
...@@ -625,11 +619,11 @@ testvariable: ...@@ -625,11 +619,11 @@ testvariable:
**警告：**启用调试跟踪可能会严重影响安全性。 输出**将**包含所有变量和其他任何秘密的内容！ 输出**将**上传到 CODECHINA 服务器，并在流水线任务日志中显示！ **警告：**启用调试跟踪可能会严重影响安全性。 输出**将**包含所有变量和其他任何秘密的内容！ 输出**将**上传到 CODECHINA 服务器，并在流水线任务日志中显示！
默认情况下，Runner 隐藏处理流水线任务时所执行操作的大多数细节。 此行为使流水线任务日志简短，并防止机密信息泄露到日志中，除非您的脚本将其写入屏幕。 默认情况下，Runner 隐藏处理流水线任务时所执行操作的大多数细节。 此行为使流水线任务日志简短，并防止机密信息泄露到日志中，除非你的脚本将其写入屏幕。
如果一项工作没有按预期进行，则可能使问题难以调查。 在这种情况下，您可以在`.codechina-ci.yml`启用调试跟踪。此功能启用 shell 的执行日志，从而产生详细的流水线任务日志，其中列出了所有已运行的命令，已设置的变量等。 如果一项工作没有按预期进行，则可能使问题难以调查。 在这种情况下，你可以在`.codechina-ci.yml`启用调试跟踪。此功能启用 shell 的执行日志，从而产生详细的流水线任务日志，其中列出了所有已运行的命令，已设置的变量等。
在启用此功能之前，您应确保作业[仅对团队成员](/docs/user/permissions.md#project-features)可见。 您还应该清除所有生成的流水线任务日志，然后才能再次显示它们。 在启用此功能之前，你应确保流水线任务[仅对团队成员](/docs/user/permissions.md#project-features)可见。 你还应该清除所有生成的流水线任务日志，然后才能再次显示它们。
要启用调试日志（跟踪），请将`CI_DEBUG_TRACE`变量设置为`true` ： 要启用调试日志（跟踪），请将`CI_DEBUG_TRACE`变量设置为`true` ：
......