简介

.gitlab.yml 学习笔记，主要作用是编排单一 job 流工具。

处理项目

• H5
• NPM
• 微信小程序
• 物料代码片段

yml 配置

# use docker image
image: localhost/node-14.18.1-slim-h5-monorepo:0.0.2-alpha

# define stages
stages:
  - install
  - test
  - build
  - pre
  - deploy

# define cache
cache: &global_cache
  key: $CI_MERGE_REQUEST_TARGET_BRANCH_NAME$CI_COMMIT_BRANCH
  # because lock file will change between merge before and after. so cache key will change.
  # key:
  #   files:
  #     - common/config/rush/pnpm-lock.yaml
  #   prefix: ${CI_MERGE_REQUEST_TARGET_BRANCH_NAME}$CI_COMMIT_BRANCH
  paths:
    - qt-*/*/node_modules
    - qt-*/*/.rush
    - common/*
    - rush.json

# define anchor
.scope: &scope
  changes:
    - 'qt-*/**/*.*'
    - 'common/**/*.*'
    - .gitlab-ci.yml
    - rush.json

.runner: &runner
  tags:
    - frontend
  interruptible: true

.before_merged_to_staging_or_master: &before_merged_to_staging_or_master
  rules:
    - if: $CI_MERGE_REQUEST_TARGET_BRANCH_NAME =~ /^(master|staging)$/ && $CI_PIPELINE_SOURCE != "schedule"
      <<: *scope

.before_merged_to_staging: &before_merged_to_staging
  rules:
    - if: $CI_MERGE_REQUEST_TARGET_BRANCH_NAME == "staging" && $CI_PIPELINE_SOURCE != "schedule"
      <<: *scope

.before_merged_to_master: &before_merged_to_master
  rules:
    - if: $CI_MERGE_REQUEST_TARGET_BRANCH_NAME == "master" && $CI_PIPELINE_SOURCE != "schedule"
      <<: *scope

.after_merged_to_staging_or_master: &after_merged_to_staging_or_master
  rules:
    - if: $CI_COMMIT_BRANCH =~ /^(master|staging)$/ && $CI_PIPELINE_SOURCE != "schedule"
      <<: *scope

.after_merged_to_staging: &after_merged_to_staging
  rules:
    - if: $CI_COMMIT_BRANCH == "staging" && $CI_PIPELINE_SOURCE != "schedule"
      <<: *scope

.after_merged_to_master: &after_merged_to_master
  rules:
    - if: $CI_COMMIT_BRANCH == "master" && $CI_PIPELINE_SOURCE != "schedule"
      <<: *scope

.build_cache: &build_cache
  artifacts:
    paths:
      - qt-pages/*/build
      - qt-*/*/dist

# all pipelines

### define job before merged to staging or master
install_test_lint:
  stage: install
  <<: *runner
  <<: *before_merged_to_staging_or_master
  # because build artifacts can't cross pipeline share
  # <<: *build_cache
  # 缓存必须要有，但是此job不需要缓存，所以随便写一个
  cache:
    key: $CI_PROJECT_NAME
    policy: pull
  before_script:
    - git remote set-url origin https://$CI_USERNAME:$CI_PUSH_TOKEN@git2.qingtingfm.com/web/$CI_PROJECT_NAME.git
    - git config --global user.email $GITLAB_USER_EMAIL
    - git config --global user.name $GITLAB_USER_ID
    - export
  script:
    # install
    - rush install
    # for other projects eslint
    - rush compile
    # unit test
    - rush test
    # lint test
    - git fetch origin
    - git checkout -b $CI_MERGE_REQUEST_SOURCE_BRANCH_NAME origin/$CI_MERGE_REQUEST_SOURCE_BRANCH_NAME
    - JOB=lint node qt-cli/cicd-job/dist/src/h5.monorepo.js
    - git checkout $CI_COMMIT_SHORT_SHA

### define job after merged to staging or master
# define job of install stage
install:
  stage: install
  <<: *runner
  <<: *after_merged_to_staging_or_master
  <<: *build_cache
  cache:
    <<: *global_cache
    policy: push
  script:
    - export
    # install
    - rush install
    # for other projects build
    - rush compile

# define job of build stage
build_stg:
  stage: build
  <<: *runner
  <<: *after_merged_to_staging
  <<: *build_cache
  cache:
    <<: *global_cache
    policy: pull
  script:
    # - rush build-stg
    - JOB=build-stg node qt-cli/cicd-job/dist/src/h5.monorepo.js

build_prd:
  stage: build
  <<: *runner
  <<: *after_merged_to_master
  <<: *build_cache
  cache:
    <<: *global_cache
    policy: pull
  script:
    # - rush build-prd
    - JOB=build-prd node qt-cli/cicd-job/dist/src/h5.monorepo.js

# define job of pre stage
h5-pre-check:
  stage: pre
  <<: *runner
  <<: *after_merged_to_master
  cache:
    <<: *global_cache
    policy: pull
  script:
    # deploy pre and check
    - JOB=deploy-pre node qt-cli/cicd-job/dist/src/h5.monorepo.js

# define job of deploy stage
deploy_stg:
  stage: deploy
  <<: *runner
  <<: *after_merged_to_staging
  cache:
    <<: *global_cache
    policy: pull
  script:
    - JOB=deploy-stg node qt-cli/cicd-job/dist/src/h5.monorepo.js

deploy_notice:
  stage: deploy
  <<: *runner
  <<: *after_merged_to_master
  cache:
    <<: *global_cache
    policy: pull
  before_script:
    - git remote set-url origin https://$CI_USERNAME:$CI_PUSH_TOKEN@git2.qingtingfm.com/web/$CI_PROJECT_NAME.git
    - git config --global user.email $GITLAB_USER_EMAIL
    - git config --global user.name $GITLAB_USER_ID
  script:
    - rush install

    # deploy h5/mp/material/npm/cdn
    - JOB=deploy-prd node qt-cli/cicd-job/dist/src/h5.monorepo.js

    # update readme
    - ts-node qt-cli/readme-generator/src/start.ts readme
    - 'git add -A && git commit -m "docs(release): update README.md [skip ci]" --no-verify && git push origin HEAD:master --no-verify'

    # notice all
    - JOB=notice node qt-cli/cicd-job/dist/src/h5.monorepo.js
  resource_group: h5_npm_mp_material


# manual trigger deploy to staging flow
.manual_deploy_rules: &manual_deploy_rules
  rules:
    - if: $CI_COMMIT_BRANCH =~ /^release\-\w+\-\d+$/i && $CI_PIPELINE_SOURCE == "web"
      <<: *scope

prepare:
  stage: install
  <<: *runner
  <<: *manual_deploy_rules
  <<: *build_cache
  cache:
    <<: *global_cache
    policy: push
  before_script:
    - git remote set-url origin https://$CI_USERNAME:$CI_PUSH_TOKEN@git2.qingtingfm.com/web/$CI_PROJECT_NAME.git
    - git config --global user.email $GITLAB_USER_EMAIL
    - git config --global user.name $GITLAB_USER_ID
    - export
  script:
    - rush install
    - rush compile
    - rush test

build_stg:
  stage: build
  <<: *runner
  <<: *manual_deploy_rules
  <<: *build_cache
  variables:
    CI_COMMIT_BEFORE_SHA: origin/$CI_DEFAULT_BRANCH
    CI_COMMIT_SHA: $CI_COMMIT_SHORT_SHA
  cache:
    <<: *global_cache
    policy: pull
  before_script:
    - git remote set-url origin https://$CI_USERNAME:$CI_PUSH_TOKEN@git2.qingtingfm.com/web/$CI_PROJECT_NAME.git
    - git config --global user.email $GITLAB_USER_EMAIL
    - git config --global user.name $GITLAB_USER_ID
    - git fetch origin
  script:
    # - rush build-stg
    - JOB=build-stg node qt-cli/cicd-job/dist/src/h5.monorepo.js

deploy_stg:
  stage: deploy
  <<: *runner
  <<: *manual_deploy_rules
  variables:
    CI_COMMIT_BEFORE_SHA: origin/$CI_DEFAULT_BRANCH
    CI_COMMIT_SHA: $CI_COMMIT_SHORT_SHA
  cache:
    <<: *global_cache
    policy: pull
  before_script:
    - git remote set-url origin https://$CI_USERNAME:$CI_PUSH_TOKEN@git2.qingtingfm.com/web/$CI_PROJECT_NAME.git
    - git config --global user.email $GITLAB_USER_EMAIL
    - git config --global user.name $GITLAB_USER_ID
    - git fetch origin
  script:
    - JOB=deploy-stg node qt-cli/cicd-job/dist/src/h5.monorepo.js

参考资料

GitLab CI/CD 相关

• GitLab 官方文档
• GitLab CI/CD 系列教程
• CSDN 系列博客

Jenkins CI/CD 相关

• 从 0 到 1 实现一套 CI/CD 流程
• CI 持续集成和 CD 持续交付