要编写GitLab CI/CD的YML文件，核心要点包括：定义stages、jobs和使用特定的关键字（如script、only、except）来控制流水线的行为。首先，需要定义流水线的各个阶段（stages），然后在每个阶段中定义具体的任务（jobs）。例如，您可以定义一个简单的流水线，包括build、test和deploy三个阶段。在build阶段，您可以编写任务来编译代码；在test阶段，您可以编写任务来运行单元测试；在deploy阶段，您可以编写任务来部署代码。通过合理配置这些任务，您可以实现高效的CI/CD流程。
一、定义STAGES
在GitLab CI/CD中，stages用于定义流水线的不同阶段。每个阶段可以包含一个或多个任务（jobs），这些任务会按照定义的顺序依次执行。例如，您可以定义以下stages：
stages:
- build
- test
- deploy
在这个示例中，流水线包括三个阶段：build、test和deploy。每个阶段都可以包含一个或多个任务。定义stages的顺序非常重要，因为任务会按照这个顺序依次执行。
二、定义JOBS
在定义好stages之后，您需要为每个阶段定义具体的任务（jobs）。任务是GitLab CI/CD中实际执行的单元，每个任务都需要包括一个或多个script命令。例如，您可以定义以下任务：
build_job:
stage: build
script:
- echo "Compiling the code..."
- make
test_job:
stage: test
script:
- echo "Running unit tests..."
- make test
deploy_job:
stage: deploy
script:
- echo "Deploying the application..."
- make deploy
在这个示例中，定义了三个任务：build_job、test_job和deploy_job。每个任务都指定了所属的stage，并定义了具体执行的script命令。
三、使用关键字控制任务执行
为了更好地控制任务的执行，您可以使用一些特定的关键字，例如only、except、when等。这些关键字可以帮助您指定任务在特定条件下执行。例如，您可以使用only关键字来指定任务仅在某些分支上执行：
deploy_job:
stage: deploy
script:
- echo "Deploying the application..."
- make deploy
only:
- master
- release/*
在这个示例中，deploy_job任务仅会在master分支和所有以release/开头的分支上执行。类似地，您可以使用except关键字来指定任务在某些分支之外执行。
四、使用ARTIFACTS存储构建产物
在CI/CD流程中，您可能需要在不同任务之间共享构建产物。为此，您可以使用artifacts关键字来指定要保存的文件或目录。例如，您可以在build_job任务中保存编译后的文件：
build_job:
stage: build
script:
- echo "Compiling the code..."
- make
artifacts:
paths:
- build/
在这个示例中，build/目录中的文件会被保存为构建产物，后续的任务可以访问这些文件。
五、使用CACHE提高构建效率
为了提高构建效率，您可以使用cache关键字来缓存依赖项或构建结果。例如，您可以缓存依赖项以避免每次构建都重新下载：
build_job:
stage: build
script:
- echo "Compiling the code..."
- make
cache:
paths:
- .m2/repository
在这个示例中，.m2/repository目录中的文件会被缓存，以便在后续构建中复用。
六、使用变量（VARIABLES）
为了在不同任务之间共享配置信息，您可以使用variables关键字定义环境变量。例如，您可以定义一个数据库连接字符串：
variables:
DATABASE_URL: "mysql://user:password@localhost:3306/dbname"
在任务中，您可以通过环境变量访问这些配置信息：
test_job:
stage: test
script:
- echo "Running unit tests..."
- make test
- echo $DATABASE_URL
七、使用服务（SERVICES）
在CI/CD流水线中，您可能需要依赖一些外部服务，例如数据库或缓存系统。为此，您可以使用services关键字来定义这些服务。例如，您可以在测试阶段启动一个MySQL服务：
test_job:
stage: test
script:
- echo "Running unit tests..."
- make test
services:
- mysql:latest
在这个示例中，test_job任务会在一个包含最新版本MySQL服务的环境中运行。
八、定义触发条件（TRIGGERS）
您可以使用触发条件来控制流水线何时启动。例如，您可以使用only关键字来指定仅在特定分支或标签上启动流水线：
stages:
- build
- test
- deploy
build_job:
stage: build
script:
- echo "Compiling the code..."
- make
only:
- master
test_job:
stage: test
script:
- echo "Running unit tests..."
- make test
only:
- master
deploy_job:
stage: deploy
script:
- echo "Deploying the application..."
- make deploy
only:
- tags
在这个示例中，build_job和test_job任务仅在master分支上执行，而deploy_job任务仅在创建标签时执行。
九、使用并行任务（PARALLEL JOBS）
为了加速流水线的执行，您可以使用parallel关键字来定义并行任务。例如，您可以并行执行多个测试任务：
stages:
- test
test_job:
stage: test
script:
- echo "Running unit tests..."
- make test
parallel:
matrix:
- TEST_SUITE: "unit"
- TEST_SUITE: "integration"
- TEST_SUITE: "e2e"
在这个示例中，test_job任务会并行执行三次，每次使用不同的TEST_SUITE环境变量。
十、使用多项目流水线（MULTI-PROJECT PIPELINES）
如果您的项目依赖于其他项目，您可以使用多项目流水线来协调多个项目的构建。例如，您可以在一个项目中触发另一个项目的流水线：
stages:
- build
trigger_job:
stage: build
trigger:
project: other-group/other-project
branch: master
在这个示例中，trigger_job任务会触发other-group/other-project项目的master分支的流水线。
十一、使用依赖项（DEPENDENCIES）
在某些情况下，您可能需要在任务之间传递构建产物。例如，您可以在test_job任务中使用build_job任务的构建产物：
stages:
- build
- test
build_job:
stage: build
script:
- echo "Compiling the code..."
- make
artifacts:
paths:
- build/
test_job:
stage: test
script:
- echo "Running unit tests..."
- make test
dependencies:
- build_job
在这个示例中，test_job任务会依赖build_job任务的构建产物。
十二、使用环境（ENVIRONMENTS）
为了在不同环境中部署应用，您可以使用environments关键字定义环境。例如，您可以定义staging和production两个环境：
stages:
- deploy
deploy_staging:
stage: deploy
script:
- echo "Deploying to staging..."
- make deploy-staging
environment:
name: staging
deploy_production:
stage: deploy
script:
- echo "Deploying to production..."
- make deploy-production
environment:
name: production
url: https://example.com
在这个示例中，定义了两个部署任务，分别部署到staging和production环境。
十三、使用手动任务（MANUAL JOBS）
在一些情况下，您可能需要手动触发某些任务。例如，您可以定义一个手动触发的部署任务：
stages:
- deploy
deploy_job:
stage: deploy
script:
- echo "Deploying the application..."
- make deploy
when: manual
在这个示例中，deploy_job任务需要手动触发。
十四、使用失败策略（FAILURE STRATEGIES）
为了处理任务失败的情况，您可以使用策略来定义失败后的行为。例如，您可以定义任务在失败后重试：
stages:
- test
test_job:
stage: test
script:
- echo "Running unit tests..."
- make test
retry:
max: 2
when:
- runner_system_failure
在这个示例中，test_job任务在runner_system_failure时会重试两次。
十五、使用扩展配置（INCLUDE）
为了提高配置的可维护性，您可以使用include关键字将配置拆分为多个文件。例如，您可以将通用配置放在一个单独的文件中：
include:
- 'common-config.yml'
stages:
- build
- test
- deploy
在这个示例中，common-config.yml文件中的配置会被包含在主配置文件中。
通过合理配置这些关键字和功能，您可以编写出高效、灵活的GitLab CI/CD YML文件，实现自动化的持续集成和持续部署流程。
相关问答FAQs：
1. 如何在 GitLab 中编写 CI/CD 的 YAML 文件？
在 GitLab 中，CI/CD 的配置文件通常使用 .gitlab-ci.yml 文件来定义。这个文件采用 YAML 格式，用于指定构建、测试和部署等操作。以下是一个简单的示例：
# 指定运行环境
image: node:14
# 定义一个 job
job1:
script:
- npm install
- npm test
tags:
- docker
在这个示例中，使用了 image 指令来指定运行环境为 node:14，然后定义了一个名为 job1 的 job，在 script 下列出了需要执行的命令。
2. 如何在 GitLab CI/CD 中使用变量？
在 GitLab 的 CI/CD 配置文件中，可以使用变量来存储和传递数据。变量可以在 .gitlab-ci.yml 文件中定义，也可以在 GitLab 项目的设置中设置全局变量。下面是一个例子：
# 定义全局变量
variables:
DATABASE_URL: "postgres://myuser:mypassword@mydb:5432/mydb"
# 使用变量
job2:
script:
- echo $DATABASE_URL
在这个例子中，通过 variables 关键字定义了一个名为 DATABASE_URL 的全局变量，然后在 job2 的 script 中通过 $DATABASE_URL 来引用这个变量。
3. 如何在 GitLab CI/CD 中实现部署到不同环境？
在 GitLab 的 CI/CD 中，可以通过不同的环境变量和条件来实现部署到不同的环境。例如，可以根据不同的分支或标签来决定部署到测试环境、预发布环境还是生产环境。以下是一个示例：
stages:
- build
- test
- deploy
build_job:
stage: build
script:
- npm install
- npm build
test_job:
stage: test
script:
- npm test
deploy_staging:
stage: deploy
script:
- echo "Deploying to staging environment"
environment:
name: staging
url: http://staging.example.com
only:
- master
deploy_production:
stage: deploy
script:
- echo "Deploying to production environment"
environment:
name: production
url: http://www.example.com
only:
- tags
在这个示例中，定义了不同的阶段（stages），以及构建、测试和部署的不同 job。通过 environment 关键字可以指定部署的环境名称和 URL，通过 only 关键字可以指定只有满足条件的情况下才执行部署操作。
希望以上内容对您有所帮助，如果您想了解更多关于 GitLab CI/CD 的内容，可以查看官网文档：
官网地址：
文档地址：
论坛地址：
原创文章，作者：jihu002，如若转载，请注明出处：https://devops.gitlab.cn/archives/13658
