如何配置GitLab Pipeline无缓存时执行npm install再走Sonarqube扫描

核心思路 #

GitLab CI原生未提供「仅缓存不存在时执行任务」的内置配置，可通过缓存规则+目录校验+跨任务变量传递实现需求：

• 绑定依赖锁文件作为缓存key，保证依赖版本不变时缓存不会失效
• 前置校验任务判断缓存目录是否存在，生成标志变量传递给后续任务
• Sonar扫描任务根据标志变量，决定是否先执行npm install

完整.gitlab-ci.yml配置示例 #

# 定义流水线阶段
stages:
  - pre-check
  - code-scan

# 全局缓存配置
cache:
  key:
    # 绑定package-lock.json哈希，依赖变更才会刷新缓存
    files:
      - package-lock.json
    # 若需要仅同一条流水线内复用缓存，可添加CI_PIPELINE_ID变量：
    # prefix: $CI_PIPELINE_ID
  paths:
    - node_modules/
  policy: pull-push

# 前置缓存校验任务
pre-check:
  stage: pre-check
  script:
    - |
      # 判断node_modules目录是否存在且不为空
      if [ -d "node_modules" ] && [ "$(ls -A node_modules)" ]; then
        echo "CACHE_EXISTS=true" >> build.env
      else
        echo "CACHE_EXISTS=false" >> build.env
      fi
  artifacts:
    reports:
      # 将变量传递到后续所有任务
      dotenv: build.env

# Sonarqube扫描任务
sonarqube-check:
  stage: code-scan
  needs: ["pre-check"]
  script:
    # 缓存不存在时先执行npm install
    - if [ "$CACHE_EXISTS" = "false" ]; then npm install; fi
    # 替换为你实际使用的Sonarqube扫描命令
    - sonar-scanner

配置说明 #

• 若仅需要同一条流水线内的不同任务复用缓存，可在缓存key中添加$CI_PIPELINE_ID前缀，避免不同流水线共享缓存
• 如果你的Sonar扫描不需要完整的node_modules依赖，可调整缓存paths配置缩小缓存体积，提升缓存拉取速度
• 锁文件可根据你的包管理器替换为yarn.lock、pnpm-lock.yaml等

内容的提问来源于stack exchange，提问作者linuxkaran