docuactions/cache を使って Docusaurus の build を高速化する

はじめに

Meta社が管理する React ベースのドキュメント管理ツール Docusaurus 。 様々な機能があり簡単に導入できますが、 Build に時間がかかってしまいます。 GitHub Actions に docuactions/cache の定義を1行追加するだけで、平均 30s 程高速化できたのでその紹介です。

docuactions/cache について

docuactions/cache は .docusaurus 及び node_modules/.cache または.yarn/.cache を cache し build を高速化してくれます。

docuactions/cache を導入する

README.md に記載されている通り、 npm ci, npm install 後に docuactions/cache@v1 を追記してください。

name: Test

on:
  push:

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
      - run: npm ci
      - uses: docuactions/cache@v1
      - run: npm run docusaurus build

上記設定を追加することで 私の環境下だと 平均 30s (早いときだと1 min) の改善が見られました。

最後に

今回は docuactions/cache を紹介しましたが Organization docuactions には cache 以外の便利な action が定義されています。

気になる方は見てみてもよいでしょう。

Ref