README.md

🦆 Node Package Managers Cache

GitHub action to cache Yarn, NPM, and PNPM cache directories!

node-pm-cache is a GitHub Action to cache Yarn, NPM, and PNPM caching directories alongside with node_modules so your workflows can go speed! ⚡

Example Workflow

name: My Workflow
on:
  push: {}
jobs:
  workflow:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repository
        uses: actions/checkout@v3

      - name: Setup Node.js 18
        uses: actions/setup-node@v3
        with:
          node-version: 18.x

      - name: Cache Yarn and node-modules
        uses: auguwu/node-pm-cache@master
        with:
          node-modules: ./node_modules
          package-manager: yarn # Leave this out to let the action to detect it.

This will produce a cache bundle with the following keys:

• <pm>-<os>-<node-version>-<hashed yarn.lock/package-lock.json/pnpm-lockfile.yaml>

Inputs

Name	Type	Description	Required?	Default Value
node-modules	Path (relative or absolute)	The node-modules directory to cache.	false	./node_modules
package-manager	pnpm/yarn/npm/detect	The package manager to cache objects.	false	"detect"

Outputs

Name	Type	Description
cache-hit	Boolean	If the package manager cache was already cached and it was restored.
package-manager	pnpm/yarn/npm	The package manager that was used.
lockfile	Path (absolute)	The lockfile path that was used to hash the primary cache key.
node-modules-cache-hit	Boolean	If the node-modules directory was cached (and restored) or not.

License

node-pm-cache is released under the MIT License with love ☆⌒ ヽ(*'､^*)chu by Noel. :3