GitLab CI/CD 的配置详解：从零开始使用 .gitlab-ci.yml 文件

news2025/2/14 5:09:14

在现代软件开发中，CI/CD（持续集成与持续部署）已成为提高开发效率和代码质量的核心实践。GitLab CI/CD 提供了强大的功能，帮助开发者自动化构建、测试和部署应用程序。而 .gitlab-ci.yml 文件是 GitLab CI/CD 配置的关键所在，本文将详细介绍 .gitlab-ci.yml 文件的基本语法与使用技巧，帮助开发者能够轻松上手。

什么是 `.gitlab-ci.yml` 文件？

.gitlab-ci.yml 是 GitLab CI/CD 的配置文件，主要用于定义一系列的任务（Jobs）和阶段（Stages），以便自动化执行构建、测试和部署过程。每当你向 GitLab 仓库提交代码时，GitLab 会根据该文件自动触发管道（Pipeline），执行相应的操作。

基本结构与关键概念

.gitlab-ci.yml 文件由几个主要部分构成：

Stages（阶段）
Jobs（任务）
Script（脚本）
Variables（变量）
Cache（缓存）
Artifacts（工件）

1. Stages（阶段）

stages 定义了任务执行的顺序。GitLab CI/CD 会根据 stages 中的顺序依次执行每个阶段。每个阶段中包含一个或多个任务，通常包括构建（build）、测试（test）和部署（deploy）。

stages:
  - build
  - test
  - deploy

在上述配置中，GitLab 会按照 build、test 和 deploy 的顺序执行任务。

2. Jobs（任务）

jobs 是 .gitlab-ci.yml 中最基本的构建单元。每个任务包含一个或多个命令（script），这些命令会在相应的阶段中执行。你可以在任务中定义具体的构建、测试和部署过程。

build:
  stage: build
  script:
    - echo "Building the application..."
    - make

在此示例中，build 任务属于 build 阶段，任务的 script 定义了需要执行的具体命令，make 命令用来构建应用程序。

3. Script（脚本）

script 是任务中执行的命令，通常由一系列 Shell 命令组成。它定义了每个任务执行的具体步骤。

test:
  stage: test
  script:
    - echo "Running tests..."
    - ./run_tests.sh

在 test 阶段，GitLab 将会执行 ./run_tests.sh 脚本文件，以运行自动化测试。

4. Variables（变量）

在 .gitlab-ci.yml 文件中，variables 用来定义全局或局部的变量，这些变量可以在任务的 script 部分引用。定义变量有助于简化配置，避免重复代码。

variables:
  PROJECT_DIR: "/home/user/myproject"
  JAVA_HOME: "/usr/lib/jvm/java-11-openjdk"

在任务中引用这些变量时，可以像这样：

build:
  script:
    - cd $PROJECT_DIR
    - mvn clean install

5. Cache（缓存）

cache 用于定义需要在不同任务之间共享的目录或文件。缓存可以帮助加速构建过程，避免每次构建时重新下载依赖项。

cache:
  paths:
    - .m2/repository/

这个配置会缓存 Maven 构建所使用的 .m2/repository/ 目录，从而加快后续任务的构建速度。

6. Artifacts（工件）

artifacts 用来定义任务完成后需要保存的文件。保存的文件可以在后续阶段使用，或供用户下载。

test:
  stage: test
  script:
    - ./run_tests.sh
  artifacts:
    paths:
      - test-results/*.xml
    expire_in: 1 week

在这个示例中，测试结果将保存为 XML 文件，并且会在一周后自动删除。

高级功能与配置

Job 之间的依赖关系

在 GitLab CI/CD 中，任务默认按照阶段的顺序依次执行，但有时你可能希望明确指定任务之间的依赖关系。可以通过 dependencies 来实现这一点。

test:
  stage: test
  script:
    - ./run_tests.sh
  dependencies:
    - build

在这个配置中，test 任务依赖于 build 任务，GitLab 会先执行 build 任务，成功后再执行 test 任务。

条件执行任务

有时你可能希望在特定条件下才执行某些任务，比如仅在特定分支上执行某些部署操作。GitLab CI/CD 支持使用 only 和 except 来限制任务的执行条件。

deploy:
  stage: deploy
  script:
    - echo "Deploying the application..."
    - scp $PROJECT_DIR/* user@remote:/path/to/deploy
  only:
    - master  # 仅在master分支执行

在这个配置中，deploy 任务只会在 master 分支上执行，避免其他分支部署到生产环境。

完整的 `.gitlab-ci.yml` 示例

stages:
  - build
  - test
  - deploy

variables:
  PROJECT_DIR: "/home/user/myproject"
  DEPLOY_DIR: "/home/user/deploy"

before_script:
  - echo "Setting up environment..."

build:
  stage: build
  script:
    - echo "Building the application..."
    - cd $PROJECT_DIR
    - make

test:
  stage: test
  script:
    - echo "Running tests..."
    - cd $PROJECT_DIR
    - ./run_tests.sh
  artifacts:
    paths:
      - test-results/*.xml
    expire_in: 1 week

deploy:
  stage: deploy
  script:
    - echo "Deploying application..."
    - scp $PROJECT_DIR/* user@remote:/path/to/deploy
  only:
    - master  # 只在master分支执行