简介
GitLab CI/CD 和 GitHub Actions 都允许您创建自动构建、测试、发布、发行和部署代码的工作流。GitLab CI/CD 和 GitHub Actions 在工作流配置方面有一些相似之处
- 工作流配置文件以 YAML 编写，并存储在代码存储库中。
- 工作流包括一个或多个作业。
- 作业包括一个或多个步骤或单个命令。
- 作业可以在托管或自托管机器上运行。
有一些差异，本指南将向您展示重要的差异，以便您可以将工作流迁移到 GitHub Actions。
作业
GitLab CI/CD 中的作业与 GitHub Actions 中的作业非常相似。在这两个系统中，作业具有以下特征
- 作业包含一系列按顺序运行的步骤或脚本。
- 作业可以在不同的机器或不同的容器中运行。
- 作业默认情况下并行运行，但可以配置为按顺序运行。
您可以在作业中运行脚本或 shell 命令。在 GitLab CI/CD 中，使用 script 键指定脚本步骤。在 GitHub Actions 中，所有脚本都使用 run 键指定。
以下是每个系统语法的示例。
作业的 GitLab CI/CD 语法
job1:
variables:
GIT_CHECKOUT: "true"
script:
- echo "Run your script here"
作业的 GitHub Actions 语法
jobs:
job1:
steps:
- uses: actions/checkout@v4
- run: echo "Run your script here"
执行程序
执行程序是作业运行的机器。GitLab CI/CD 和 GitHub Actions 都提供了执行程序的托管和自托管变体。在 GitLab CI/CD 中，tags 用于在不同的平台上运行作业，而在 GitHub Actions 中，则使用 runs-on 键。
以下是每个系统语法的示例。
执行程序的 GitLab CI/CD 语法
windows_job:
tags:
- windows
script:
- echo Hello, %USERNAME%!
linux_job:
tags:
- linux
script:
- echo "Hello, $USER!"
执行程序的 GitHub Actions 语法
windows_job:
runs-on: windows-latest
steps:
- run: echo Hello, %USERNAME%!
linux_job:
runs-on: ubuntu-latest
steps:
- run: echo "Hello, $USER!"
有关更多信息，请参阅“GitHub Actions 的工作流语法”。
Docker 镜像
GitLab CI/CD 和 GitHub Actions 都支持在 Docker 镜像中运行作业。在 GitLab CI/CD 中，Docker 镜像使用 image 键定义，而在 GitHub Actions 中使用 container 键定义。
以下是每个系统语法的示例。
Docker 镜像的 GitLab CI/CD 语法
my_job:
image: node:10.16-jessie
Docker 镜像的 GitHub Actions 语法
jobs:
my_job:
container: node:10.16-jessie
有关更多信息，请参阅“GitHub Actions 的工作流语法”。
条件和表达式语法
GitLab CI/CD 使用 rules 确定作业是否针对特定条件运行。GitHub Actions 使用 if 关键字阻止作业在不满足条件的情况下运行。
以下是每个系统语法的示例。
条件和表达式的 GitLab CI/CD 语法
deploy_prod:
stage: deploy
script:
- echo "Deploy to production server"
rules:
- if: '$CI_COMMIT_BRANCH == "master"'
条件和表达式的 GitHub Actions 语法
jobs:
deploy_prod:
if: contains( github.ref, 'master')
runs-on: ubuntu-latest
steps:
- run: echo "Deploy to production server"
有关更多信息，请参阅“表达式”。
作业之间的依赖关系
GitLab CI/CD 和 GitHub Actions 都允许您为作业设置依赖关系。在这两个系统中，默认情况下作业并行运行，但 GitHub Actions 中的作业依赖关系可以使用 needs 键明确指定。GitLab CI/CD 还具有 stages 概念，其中阶段中的作业并发运行，但下一阶段将在前一阶段中的所有作业完成后开始。您可以在 GitHub Actions 中使用 needs 键重新创建此场景。
以下是每个系统语法的示例。工作流从两个并行运行的作业 build_a 和 build_b 开始，当这些作业完成后，另一个名为 test_ab 的作业将运行。最后，当 test_ab 完成后，deploy_ab 作业将运行。
作业之间依赖关系的 GitLab CI/CD 语法
stages:
- build
- test
- deploy
build_a:
stage: build
script:
- echo "This job will run first."
build_b:
stage: build
script:
- echo "This job will run first, in parallel with build_a."
test_ab:
stage: test
script:
- echo "This job will run after build_a and build_b have finished."
deploy_ab:
stage: deploy
script:
- echo "This job will run after test_ab is complete"
GitHub Actions 作业之间的依赖关系语法
jobs:
build_a:
runs-on: ubuntu-latest
steps:
- run: echo "This job will be run first."
build_b:
runs-on: ubuntu-latest
steps:
- run: echo "This job will be run first, in parallel with build_a"
test_ab:
runs-on: ubuntu-latest
needs: [build_a,build_b]
steps:
- run: echo "This job will run after build_a and build_b have finished"
deploy_ab:
runs-on: ubuntu-latest
needs: [test_ab]
steps:
- run: echo "This job will run after test_ab is complete"
有关详细信息，请参阅“GitHub Actions 的工作流语法”。
计划工作流
GitLab CI/CD 和 GitHub Actions 都允许你在特定时间间隔运行工作流。在 GitLab CI/CD 中，管道计划使用 UI 配置，而在 GitHub Actions 中，你可以使用“on”键在计划的时间间隔触发工作流。
有关详细信息，请参阅“触发工作流的事件”。
变量和机密
GitLab CI/CD 和 GitHub Actions 支持在管道或工作流配置文件中设置变量，并使用 GitLab 或 GitHub UI 创建机密。
有关详细信息，请参阅“变量”和“在 GitHub Actions 中使用机密”。
缓存
GitLab CI/CD 和 GitHub Actions 在配置文件中提供了一种手动缓存工作流文件的方法。
以下是每个系统语法的示例。
GitLab CI/CD 的缓存语法
image: node:latest
cache:
key: $CI_COMMIT_REF_SLUG
paths:
- .npm/
before_script:
- npm ci --cache .npm --prefer-offline
test_async:
script:
- node ./specs/start.js ./specs/async.spec.js
GitHub Actions 的缓存语法
jobs:
test_async:
runs-on: ubuntu-latest
steps:
- name: Cache node modules
uses: actions/cache@v3
with:
path: ~/.npm
key: v1-npm-deps-${{ hashFiles('**/package-lock.json') }}
restore-keys: v1-npm-deps-
工件
GitLab CI/CD 和 GitHub Actions 都可以将作业创建的文件和目录上载为工件。在 GitHub Actions 中，工件可用于在多个作业之间保留数据。
以下是每个系统语法的示例。
GitLab CI/CD 的工件语法
script:
artifacts:
paths:
- math-homework.txt
GitHub Actions 的工件语法
- name: Upload math result for job 1
uses: actions/upload-artifact@v4
with:
name: homework
path: math-homework.txt
有关详细信息，请参阅“将工作流数据存储为工件”。
数据库和服务容器
这两个系统都允许你包含用于数据库、缓存或其他依赖关系的附加容器。
在 GitLab CI/CD 中，作业的容器使用image键指定，而 GitHub Actions 使用container键。在这两个系统中，附加服务容器使用services键指定。
以下是每个系统语法的示例。
GitLab CI/CD 的数据库和服务容器语法
container-job:
variables:
POSTGRES_PASSWORD: postgres
# The hostname used to communicate with the
# PostgreSQL service container
POSTGRES_HOST: postgres
# The default PostgreSQL port
POSTGRES_PORT: 5432
image: node:10.18-jessie
services:
- postgres
script:
# Performs a clean installation of all dependencies
# in the `package.json` file
- npm ci
# Runs a script that creates a PostgreSQL client,
# populates the client with data, and retrieves data
- node client.js
tags:
- docker
GitHub Actions 的数据库和服务容器语法
jobs:
container-job:
runs-on: ubuntu-latest
container: node:10.18-jessie
services:
postgres:
image: postgres
env:
POSTGRES_PASSWORD: postgres
steps:
- name: Check out repository code
uses: actions/checkout@v4
# Performs a clean installation of all dependencies
# in the `package.json` file
- name: Install dependencies
run: npm ci
- name: Connect to PostgreSQL
# Runs a script that creates a PostgreSQL client,
# populates the client with data, and retrieves data
run: node client.js
env:
# The hostname used to communicate with the
# PostgreSQL service container
POSTGRES_HOST: postgres
# The default PostgreSQL port
POSTGRES_PORT: 5432
有关详细信息，请参阅“关于服务容器”。