創(chuàng)建并運(yùn)行您的第一個(gè) GitLab CI/CD 管道，在開始之前，請(qǐng)確保您擁有：

• GitLab 中您想要使用 CI/CD 的項(xiàng)目
• 項(xiàng)目的維護(hù)者或所有者角色

如果您沒有項(xiàng)目，可以在 https://gitlab.com 上免費(fèi)創(chuàng)建一個(gè)公共項(xiàng)目

• 在存儲(chǔ)庫的根目錄下創(chuàng)建一個(gè) .gitlab-ci.yml 文件。該文件是您定義 CI/CD 作業(yè)的地方
• 轉(zhuǎn)到Settings > CI/CD 并展開運(yùn)行程序，只要您至少有一個(gè)運(yùn)行器處于活動(dòng)狀態(tài)，旁邊有一個(gè)綠色圓圈，您就有一個(gè)運(yùn)行器可以處理您的工作

default:
  image: node:16

windows_job:
  only:
    - master
  tags:
    - windows
  script:
    - echo Hello, %USERNAME%!

linux_job: tags:
    - linux script:
    - echo "Hello, $USER!"

tags 用于在不同的平臺(tái)上運(yùn)行作業(yè)，only 控制 master 分支提交觸發(fā)

• after_script
• artifacts
• before_script
• cache
• image
• interruptible
• retry
• services
• tags
• timeout

include:
  - local: '/temp/.gitlab-ci-template.yml'

在 11.4 中移至 GitLab 免費(fèi)版，使用 include 將外部 YAML 文件包含在您的 CI/CD 配置中

include:
  - local: '/temp/.gitlab-ci-template.yml'

使用 include:local 包含與 .gitlab-ci.yml 文件位于同一存儲(chǔ)庫中的文件

include:
  - remote: 'https://gitlab.com/example-project/-/raw/main/.gitlab-ci.yml'

使用帶有完整 URL 的 include:remote 來包含來自不同位置的文件

使用階段來定義包含作業(yè)組的階段。如果 .gitlab-ci.yml 文件中未定義階段，則默認(rèn)管道階段為：

• .pre
• build
• test
• deploy
• .post

stages:
  - build
  - test
  - deploy

您可以在 workflow: 中使用 name 來定義管道的名稱

workflow:
  name: '分支管道：$CI_COMMIT_BRANCH'

根據(jù)管道條件具有不同管道名稱的配置：

variables:
  PIPELINE_NAME: '默認(rèn)管道名稱'

workflow:
  name: '$PIPELINE_NAME'
  rules:
    - if: '$CI_PIPELINE_SOURCE == "merge_request_event"'
      variables:
        PIPELINE_NAME: 'MR pipeline: $CI_COMMIT_BRANCH'
    - if: '$CI_MERGE_REQUEST_LABELS =~ /pipeline:run-in-ruby3/'
      variables:
        PIPELINE_NAME: 'Ruby 3 pipeline'

工作流(workflow)中的 rules 關(guān)鍵字類似于作業(yè)中定義的 rules，但控制是否創(chuàng)建整個(gè)管道

• rules: if
• rules: changes
• rules: exists
• when
• variables

workflow:
  rules:
    - if: $CI_COMMIT_TITLE =~ /-draft$/
      when: never
    - if: $CI_PIPELINE_SOURCE == "merge_request_event"
    - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH

在每個(gè)作業(yè)（包括失敗的作業(yè)）之后運(yùn)行的命令數(shù)組

job:
  script:
    - echo "示例腳本部分"
  after_script:
    - echo "在“script”部分完成后執(zhí)行此命令"

在每個(gè)作業(yè)的 script 命令之前運(yùn)行，但在工件恢復(fù)之后運(yùn)行

job:
  before_script:
    - echo "在任何“script:”命令之前執(zhí)行此命令"
  script:
    - echo "“before_script”命令之后執(zhí)行"

job1:
  script: rspec
  coverage: '/Code coverage: \d+\.\d+/'

使用自定義正則表達(dá)式的覆蓋率來配置如何從作業(yè)輸出中提取代碼覆蓋率

stages:
  - stage1
  - stage2
  - stage3

step-1:
  stage: stage1
  script:
    - echo "可以取消"
  interruptible: true

step-2:
  stage: stage2
  script:
    - echo "不能取消"

step-3:
  stage: stage3
  script:
    - echo "因?yàn)榈?2 步無法取消，所以此步驟永遠(yuǎn)無法取消，即使它被設(shè)置為可中斷"
  interruptible: true

如果在作業(yè)完成之前啟動(dòng)較新的管道時(shí)應(yīng)取消作業(yè)，則使用可中斷的

pages:
  stage: deploy
  script:
    - mkdir .public
    - cp -r * .public
    - mv .public public
  artifacts:
    paths:
      - public
  rules:
    - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
  environment: production

使用頁面定義將靜態(tài)內(nèi)容上傳到 GitLab 的 GitLab Pages 作業(yè)。然后將內(nèi)容發(fā)布為網(wǎng)站

deploy-to-production:
  script: deploy
  resource_group: production

創(chuàng)建一個(gè)資源組，以確保作業(yè)在同一項(xiàng)目的不同管道之間互斥

job:
  tags:
    - ruby
    - postgres

使用標(biāo)簽從項(xiàng)目可用的所有運(yùn)行器列表中選擇特定運(yùn)行器

job1:
  script: "bundle exec rspec"

job2:
  script:
    - uname -a
    - bundle exec rspec

使用腳本指定運(yùn)行器執(zhí)行的命令

build:
  script: build.sh
  timeout: 3 hours 30 minutes

test:
  script: rspec
  timeout: 3h 30m

為特定作業(yè)配置超時(shí)。 如果作業(yè)運(yùn)行時(shí)間超過超時(shí)時(shí)間，則作業(yè)失敗

使用 when 配置作業(yè)運(yùn)行的條件。如果未在作業(yè)中定義，則默認(rèn)值為 when:on_success

stages:
  - build
  - cleanup_build
  - test
  - deploy
  - cleanup

build_job:
  stage: build
  script:
    - make build

cleanup_build_job:
  stage: cleanup_build
  script:
    - cleanup build when failed
  when: on_failure

test_job:
  stage: test
  script:
    - make test

deploy_job:
  stage: deploy
  script:
    - make deploy
  when: manual
  environment: production

cleanup_job:
  stage: cleanup
  script:
    - cleanup after jobs
  when: always

路徑是相對(duì)于項(xiàng)目目錄（$CI_PROJECT_DIR）的，不能直接鏈接到項(xiàng)目目錄之外

job:
  artifacts:
    paths:
      - binaries/
      - .config

防止將文件添加到 artifacts 存檔中

artifacts:
  paths:
    - binaries/
  exclude:
    - binaries/**/*.o

指定作業(yè) artifacts 在它們過期和被刪除之前存儲(chǔ)多長時(shí)間

job:
  artifacts:
    expire_in: 1 week

• '42'
• 42 seconds
• 3 mins 4 sec
• 2 hrs 20 min
• 2h20min
• 6 mos 1 day
• 47 yrs 6 mos and 4d
• 3 weeks and 2 days
• never

使用 artifacts:expose_as 關(guān)鍵字在合并請(qǐng)求 UI 中公開作業(yè) artifacts

test:
  script: ["echo 'test' > file.txt"]
  artifacts:
    expose_as: 'artifact 1'
    paths: ['file.txt']

定義創(chuàng)建的 artifacts 存檔的名稱。您可以為每個(gè)存檔指定一個(gè)唯一的名稱

job:
  artifacts:
    name: "job1-artifacts-file"
    paths:
      - binaries/

確定作業(yè)工件是否應(yīng)該公開可用

job:
  artifacts:
    public: false

收集作業(yè)中包含的模板生成的 artifacts

rspec:
  stage: test
  script:
    - bundle install
    - rspec --format RspecJunitFormatter --out rspec.xml
  artifacts:
    reports:
      junit: rspec.xml

將所有 Git 未跟蹤文件添加為 artifacts（連同在 artifacts:paths 中定義的路徑）

job:
  artifacts:
    untracked: true

作業(yè)失敗或盡管失敗時(shí)上傳 artifacts

job:
  artifacts:
    when: on_failure

rspec:
  script:
    - echo "此作業(yè)使用緩存"
  cache:
    key: binaries-cache
    paths:
      - binaries/*.apk
      - .config

關(guān)鍵字來選擇要緩存的文件或目錄

rspec:
  script: test
  cache:
    untracked: true
    paths:
      - binaries/

使用 untracked: true 緩存 Git 存儲(chǔ)庫中所有未跟蹤的文件

rspec:
  script: rspec
  cache:
    paths:
      - rspec/
    when: 'always'

使用 cache:when 根據(jù)作業(yè)的狀態(tài)定義何時(shí)保存緩存

prepare-dependencies-job:
  stage: build
  cache:
    key: gems
    paths:
      - vendor/bundle
    policy: push
  script:
    - echo "此作業(yè)僅下載依賴項(xiàng)并構(gòu)建緩存"
    - echo "正在下載依賴..."

faster-test-job:
  stage: test
  cache:
    key: gems
    paths:
      - vendor/bundle
    policy: pull
  script:
    - echo "此作業(yè)腳本使用緩存，但不更新它"
    - echo "運(yùn)行測(cè)試..."

要更改緩存的上傳和下載行為，請(qǐng)使用 cache:policy 關(guān)鍵字

deploy to production:
  stage: deploy
  script: git push production HEAD:main
  environment:
    name: production

為環(huán)境設(shè)置名稱

deploy to production:
  stage: deploy
  script: git push production HEAD:main
  environment:
    name: production
    url: https://prod.example.com

為環(huán)境設(shè)置 URL

關(guān)閉（停止）環(huán)境可以通過在環(huán)境下定義的 on_stop 關(guān)鍵字來實(shí)現(xiàn)。 它聲明運(yùn)行以關(guān)閉環(huán)境的不同作業(yè)

stop_review_app:
  stage: deploy
  variables:
    GIT_STRATEGY: none
  script: make delete-app
  when: manual
  environment:
    name: review/$CI_COMMIT_REF_SLUG
    action: stop

review_app:
  script: deploy-review-app
  environment:
    name: review/$CI_COMMIT_REF_SLUG
    auto_stop_in: 1 day

• 168 hours
• 7 days
• one week
• never

auto_stop_in 關(guān)鍵字指定環(huán)境的生命周期。 當(dāng)環(huán)境到期時(shí)，GitLab 會(huì)自動(dòng)停止它

deploy:
  stage: deploy
  script: make deploy-app
  environment:
    name: production
    kubernetes:
      namespace: production

使用 kubernetes 關(guān)鍵字將部署配置到與您的項(xiàng)目關(guān)聯(lián)的 Kubernetes 集群

deploy:
  script: echo
  environment:
    name: customer-portal
    deployment_tier: production

• production
• staging
• testing
• development
• other

deploy as review app:
  stage: deploy
  script: make deploy
  environment:
    name: review/$CI_COMMIT_REF_SLUG
    url: https://$CI_ENVIRONMENT_SLUG.example.com/

image:
  name: "registry.example.com/my/image:latest"

作業(yè)運(yùn)行所在的 Docker 鏡像的名稱。類似于它自己使用的鏡像

image:
  name: super/sql:experimental
  entrypoint: [""]

作為容器入口點(diǎn)執(zhí)行的命令或腳本

job1:
  script: echo "單一拉動(dòng)政策"
  image:
    name: ruby:3.0
    pull_policy: if-not-present

job2:
  script: echo "多重拉動(dòng)政策"
  image:
    name: ruby:3.0
    pull_policy: [always, if-not-present]

運(yùn)行器用于獲取 Docker 映像的拉取策略

當(dāng)作業(yè)使用需求時(shí)，它不再默認(rèn)下載先前階段的所有工件，因?yàn)橛行枨蟮淖鳂I(yè)可以在早期階段完成之前開始

test-job1:
  stage: test
  needs:
    - job: build_job1
      artifacts: true

test-job2:
  stage: test
  needs:
    - job: build_job2
      artifacts: false

test-job3:
  needs:
    - job: build_job1
      artifacts: true
    - job: build_job2
    - build_job3

create-artifact:
  stage: build
  script: echo "sample artifact" > artifact.txt
  artifacts:
    paths: [artifact.txt]

child-pipeline:
  stage: test
  trigger:
    include: child.yml
    strategy: depend
  variables:
    PARENT_PIPELINE_ID: $CI_PIPELINE_ID

子管道可以從其父管道中的作業(yè)或同一父子管道層次結(jié)構(gòu)中的另一個(gè)子管道下載工件

您可以使用 needs:pipeline 關(guān)鍵字將管道狀態(tài)從上游管道鏡像到橋接作業(yè)

upstream_bridge:
  stage: test
  needs:
    pipeline: other/project

deploy:
  script: cap staging deploy
  only:
    variables:
      - $RELEASE == "staging"
      - $STAGING

根據(jù) CI/CD 變量的狀態(tài)，使用 only:variables 或 except:variables 關(guān)鍵字來控制何時(shí)將作業(yè)添加到管道

deploy:
  only:
    kubernetes: active

使用 only:kubernetes 或 except:kubernetes 來控制當(dāng) Kubernetes 服務(wù)在項(xiàng)目中處于活動(dòng)狀態(tài)時(shí)是否將作業(yè)添加到管道中

job:
  script: echo "為新標(biāo)簽運(yùn)行發(fā)布作業(yè)"
  release:
    tag_name: $CI_COMMIT_TAG
    description: 'Release description'
  rules:
    - if: $CI_COMMIT_TAG

必需的。發(fā)布的 Git 標(biāo)簽

release_job:
  stage: release
  release:
    tag_name: $CI_COMMIT_TAG
    description: 'Release description'
    tag_message: 'Annotated tag message'

如果標(biāo)簽不存在，則新創(chuàng)建的標(biāo)簽將使用 tag_message 指定的消息進(jìn)行注釋

release_job:
  stage: release
  release:
    name: 'Release $CI_COMMIT_TAG'

發(fā)布名稱。如果省略，它會(huì)填充 release:tag_name 的值

job:
  release:
    tag_name: ${MAJOR}_${MINOR}_${REVISION}
    description: './path/to/CHANGELOG.md'

版本的詳細(xì)描述

發(fā)布的 ref，如果發(fā)布：tag_name 尚不存在

與版本關(guān)聯(lián)的每個(gè)里程碑的標(biāo)題

released_at: '2021-03-15T08:00:00Z'

發(fā)布準(zhǔn)備就緒的日期和時(shí)間

assets:
  links:
    - name: 'asset1'
      url: 'https://example.com/assets/1'
    - name: 'asset2'
      url: 'https://example.com/assets/2'
      filepath: '/pretty/url/1' # 可選的
      link_type: 'other' # 可選的

使用 release:assets:links 在發(fā)布中包含資產(chǎn)鏈接

job:
  script: echo "Hello, Rules!"
  rules:
    - if: $CI_MERGE_REQUEST_SOURCE_BRANCH_NAME =~ /^feature/ && $CI_MERGE_REQUEST_TARGET_BRANCH_NAME != $CI_DEFAULT_BRANCH
      when: never
    - if: $CI_MERGE_REQUEST_SOURCE_BRANCH_NAME =~ /^feature/
      when: manual
      allow_failure: true
    - if: $CI_MERGE_REQUEST_SOURCE_BRANCH_NAME

使用 rules:if 子句指定何時(shí)將作業(yè)添加到管道

job:
  script: docker build -t my-image:$CI_COMMIT_REF_SLUG .
  rules:
    - exists:
        - Dockerfile

當(dāng)存儲(chǔ)庫中存在某些文件時(shí)，使用 exists 運(yùn)行作業(yè)

job:
  script: echo "Hello, Rules!"
  rules:
    - if: $CI_MERGE_REQUEST_TARGET_BRANCH_NAME == $CI_DEFAULT_BRANCH
      when: manual
      allow_failure: true

在規(guī)則中使用 allow_failure: true 允許作業(yè)失敗而不停止管道

job:
  variables:
    DEPLOY_VARIABLE: "default-deploy"
  rules:
    - if: $CI_COMMIT_REF_NAME == $CI_DEFAULT_BRANCH
      variables:                              # 覆蓋定義的 DEPLOY_VARIABLE
        DEPLOY_VARIABLE: "deploy-production"  # 在工作層面
    - if: $CI_COMMIT_REF_NAME =~ /feature/
      variables:
        IS_A_FEATURE: "true"                  # 定義一個(gè)新變量
  script:
    - echo "以 $DEPLOY_VARIABLE 作為參數(shù)運(yùn)行腳本"
    - echo "如果 $IS_A_FEATURE 存在則運(yùn)行另一個(gè)腳本"

在規(guī)則中使用變量來為特定條件定義變量