Oct 12, 2020

Cache Yarn in Github Actions

在 CI 中缓存安装下来的依赖项是提速的关键，Github Actions 官方文档 (opens new window) 提供了如下方案 (NPM)：

jobs:
  build:
    # ...
    - name: Cache node modules
      uses: actions/[email protected]
      env:
        cache-name: cache-node-modules
      with:
        # npm cache files are stored in `~/.npm` on Linux/macOS
        path: ~/.npm
        key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }}
        restore-keys: |
          ${{ runner.os }}-build-${{ env.cache-name }}-
          ${{ runner.os }}-build-
          ${{ runner.os }}-
    - name: Install Dependencies
      run: npm install
    # ...

Yarn 则复杂，多了一步操作（文档 (opens new window)）:

- name: Get yarn cache directory path
  id: yarn-cache-dir-path
  run: echo "::set-output name=dir::$(yarn cache dir)"
- uses: actions/[email protected]
  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-

这些方案可以说是又臭又长，我只想简单做个 cache，何必让我关心那么多东西？项目多的话，简直疯了。看看人家 Gitlab 的方案：

cache:
  key: ${CI_COMMIT_REF_SLUG}
  paths:
    - node_modules/

简单、明确。

因此，我找到了这个 action c-hive/gha-yarn-cache (opens new window) 作为替代，现在代码可以简化为：

jobs:
  build:
      # ...
      - uses: c-hive/gha-yarn-[email protected]
      - run: yarn --frozen-lockfile
      # ...

一行解决。

Last Updated: 9 days ago