如何在 GitHub Actions 中缓存 yarn 包

Question

我正在使用 GitHub Actions 来构建我的 TypeScript 项目。每次运行操作时，我都会等待 3 分钟以安装所有依赖项。

有没有办法缓存纱线依赖项，所以构建时间会更快？

我试过这个：

     - name: Get yarn cache directory path
       id: yarn-cache-dir-path
       run: echo "::set-output name=dir::$(yarn cache dir)"

     - uses: actions/cache@v1
       id: yarn-cache # use this to check for `cache-hit` (`steps.yarn-cache.outputs.cache-hit != 'true'`)
       with:
         path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
         key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
         restore-keys: |
           ${{ runner.os }}-yarn-

    - name: Install yarn
      run: npm install -g yarn

    - name: Install project dependencies
      run: yarn

但构建时间仍然相同。

Answer 1

正如github 包的自述文件所说：

steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v2
  with:
    node-version: '14'
    cache: 'npm' # or yarn
- run: npm install
- run: npm test

编辑：

事实证明，文档的编写方式非常具有误导性，他们进行了更新，以明确它不会缓存node_modules文件夹，而只会缓存全局缓存目录，如本期所述。

也正如 Mrchief 在评论中所说：

...您仍然会遇到npm i time，只需节省从互联网下载的时间（如果模块位于 npm 缓存中）

因此，您仍然应该使用从互联网下载软件包来节省时间，但如果您想缓存node_modules文件夹，请检查使用actions/cache 的其他答案。

您还应该检查Quang Lam 的答案及其关于为什么不应该缓存node_modules文件夹的评论。

Answer 2

     - name: Get yarn cache directory path
       id: yarn-cache-dir-path
       run: echo "::set-output name=dir::$(yarn cache dir)"

     - uses: actions/cache@v1
       id: yarn-cache # use this to check for `cache-hit` (`steps.yarn-cache.outputs.cache-hit != 'true'`)
       with:
         path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
         key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
         restore-keys: |
           ${{ runner.os }}-yarn-

上面的缓存代码只缓存和恢复yarn缓存目录，不缓存node_modules目录。因此，如果您使用此代码（@Edric 的回答），

- name: Install project dependencies
  if: steps.yarn-cache.outputs.cache-hit != 'true' # Over here!
  run: yarn

node_modules 未创建，您将收到未找到依赖项错误。

相反，你可以使用这个：

- name: Install project dependencies
  run: yarn --prefer-offline

这告诉yarn始终运行但尽可能使用缓存下载（在上面提到的缓存目录中）而不是从服务器下载。

您也可以node_modules直接缓存目录，当缓存可用时跳过安装步骤。这实际上是不推荐的（见评论）。例子：

    - name: Get yarn cache directory path
      id: yarn-cache-dir-path
      run: echo "::set-output name=dir::$(yarn cache dir)"
    - name: Cache yarn cache
      uses: actions/cache@v2
      id: cache-yarn-cache
      with:
        path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
        key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
        restore-keys: |
          ${{ runner.os }}-yarn-
    - name: Cache node_modules
      id: cache-node-modules
      uses: actions/cache@v2
      with:
        path: node_modules
        key: ${{ runner.os }}-${{ matrix.node-version }}-nodemodules-${{ hashFiles('**/yarn.lock') }}
        restore-keys: |
          ${{ runner.os }}-${{ matrix.node-version }}-nodemodules-
    - run: yarn
      if: |
        steps.cache-yarn-cache.outputs.cache-hit != 'true' ||
        steps.cache-node-modules.outputs.cache-hit != 'true'

Answer 3

actions/setup-node自 v2 起支持缓存并提供多个自定义选项。

- uses: actions/checkout@v3

- name: Setup Node.js
  uses: actions/setup-node@v3
  with:
    node-version: '16'
    cache: 'yarn'

- name: Install JS dependencies
  run: yarn install

缓存按照建议进行，仅缓存yarn cache dir和不缓存node_modules。node_modules不建议使用缓存，因为它可能会导致问题，例如当节点版本更改时。

_旧答案：

_{这是专门用于 Yarn 的 1-liner 缓存：https ://github.com/c-hive/gha-yarn-cache}

_{它按照 GitHub 的建议进行缓存。支持 Yarn v1 和 v2。}

_{NPM 相同：https: //github.com/c-hive/gha-npm-cache}

Answer 4

如id缓存步骤字段旁边的评论中所述：

用它来检查cache-hit( steps.yarn-cache.outputs.cache-hit != 'true')

您缺少if确定是否应运行该步骤的条件属性：

- name: Install yarn
  run: npm install -g yarn

- name: Install project dependencies
  if: steps.yarn-cache.outputs.cache-hit != 'true' # Over here!
  run: yarn

PS您可能应该使用Setup NodeJS GitHub Action，它另外为您设置Yarn：

- uses: actions/setup-node@v1
  with:
    node-version: '10.x' # The version spec of the version to use.

有关有效输入的完整列表，请参阅action.yml文件。

编辑：事实证明，Yarn 包含在GitHub 托管的 Ubuntu 18.04.4 LTS ( ubuntu-latest/ ubuntu-18.04) runner上安装的软件列表中，因此无需包含全局安装 Yarn 的步骤。