如何在 GitLab CI 中有一个“每个 package.json 的缓存”文件？

Question

我有一个使用 GitLab CI 构建、测试和部署的 Vue Web 应用程序。

GitLab CI 有一个“Cache”功能，可以缓存 Job 的特定产品，这样可以避免将来在同一 Pipeline 中运行 Job，而是使用缓存的产品。

我想通过缓存node_modules 目录来提高我的工作流程的性能，以便它可以跨管道共享。

GitLab Docs suggests 使用${CI_COMMIT_REF_SLUG} 作为缓存键来实现这一点。但是，这意味着“每个分支缓存”，我想对此进行改进。

我想要一个缓存“每个 package.json”。即只有package.json的内容发生变化，缓存键才会变化，npm install才会运行。

我正在考虑使用package.json 文件内容的哈希值作为缓存键。 GitLab CI 可以做到这一点吗？如果有，怎么做？

Answer 1

对于该行为，使用带有静态缓存名称的 only:changes 参数。

例如：

install:
  image: node:latest
  script:
    - npm install
  cache:
    untracked: true 
    key: npm  #static name, can use any branch, any commit, etc..
    paths:
      - node_modules
  only:  #Only execute this job when theres a change in package.json
    changes:
      - package.json

如果您需要阅读本文以在跑步者中正确设置缓存： https://docs.gitlab.com/runner/configuration/autoscale.html#distributed-runners-cachinghttps://docs.gitlab.com/ee/ci/caching/

Answer 2

现在可以从 Gilab Runner v12.5 开始

cache:
  key:
    files:
      - Gemfile.lock
      - package-lock.json // or yarn.lock
  paths:
    - vendor/ruby
    - node_modules

这意味着缓存key 将是根据更改给定文件的最近提交（最多两个，如果列出两个文件）计算的 SHA 校验和。每当这些文件中的一个发生更改时，都会计算一个新的缓存键并创建一个新的缓存。任何未来使用相同的Gemfile.lock 和package.json 和cache:key:files 运行的作业都将使用新的缓存，而不是重建依赖项。

更多信息：https://docs.gitlab.com/ee/ci/yaml/#cachekeyfiles

还要确保在 CI 作业中始终使用 --frozen-lockfile 标志。 （或npm ci） 常规的npm install 或yarn install / yarn 命令会生成新的锁定文件，在您再次安装软件包之前您通常不会注意到它。从而使您的构建工件和缓存不一致。