add pnpm store caching

.github/workflows/test.yaml

@@ -22,7 +22,7 @@ jobs:
           - windows-latest
 
     steps:
-      - uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4.3.1
+      - uses: actions/checkout@v4
 
       - name: Run the action
         uses: ./
@@ -51,7 +51,7 @@ jobs:
           - windows-latest
 
     steps:
-      - uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4.3.1
+      - uses: actions/checkout@v4
 
       - name: Run the action
         uses: ./
@@ -74,8 +74,8 @@ jobs:
       fail-fast: false
       matrix:
         os:
-          # macos is excluded from this test because node 12 is no longer available on this platform
           - ubuntu-latest
+          - macos-latest
           - windows-latest
 
         standalone:
@@ -83,7 +83,7 @@ jobs:
           - false
 
     steps:
-      - uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4.3.1
+      - uses: actions/checkout@v4
 
       - name: Run the action
         uses: ./
@@ -92,7 +92,7 @@ jobs:
           standalone: ${{ matrix.standalone }}
 
       - name: install Node.js
-        uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0
+        uses: actions/setup-node@v4
         with:
           # pnpm@7.0.0 is not compatible with Node.js 12
           node-version: 12.22.12
@@ -160,7 +160,7 @@ jobs:
                 - yarn
 
     steps:
-      - uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4.3.1
+      - uses: actions/checkout@v4
 
       - name: Run the action
         uses: ./

README.md

@@ -125,7 +125,7 @@ jobs:
       - uses: pnpm/action-setup@v4
         with:
           version: 10
-          run_install: |
+          run_install:
             - recursive: true
               args: [--strict-peer-dependencies]
             - args: [--global, gulp, prettier, typescript]

action.yml

@@ -24,7 +24,7 @@ inputs:
     required: false
     default: 'pnpm-lock.yaml'
   package_json_file:
-    description: File path to the package.json to read "packageManager" configuration. This path must be relative to the repository root (GITHUB_WORKSPACE).
+    description: File path to the package.json to read "packageManager" configuration
     required: false
     default: 'package.json'
   standalone:

package.json

@@ -13,6 +13,7 @@
     "@actions/glob": "^0.5.0",
     "@types/expand-tilde": "^2.0.2",
     "@types/node": "^20.11.5",
+    "@types/node-fetch": "^2.6.11",
     "expand-tilde": "^2.0.2",
     "yaml": "^2.3.4",
     "zod": "^3.22.4"

pnpm-lock.yaml

@@ -26,6 +26,9 @@ importers:
       '@types/node':
         specifier: ^20.11.5
         version: 20.17.17
+      '@types/node-fetch':
+        specifier: ^2.6.11
+        version: 2.6.12
       expand-tilde:
         specifier: ^2.0.2
         version: 2.0.2
@@ -137,6 +140,9 @@ packages:
   '@types/expand-tilde@2.0.2':
     resolution: {integrity: sha512-wlsMYiapmIR4Eq/Z0qysN8xaDMjSkO6AIDNFx9oxgWGeKVA1jU+NzwPRZErBNP5z6/dx6QNkNpKglBGPO9OkTA==}
 
+  '@types/node-fetch@2.6.12':
+    resolution: {integrity: sha512-8nneRWKCg3rMtF69nLQJnOYUcbafYeFSjqkw3jCRLsqkWFlHaoQrr5mXmofFGOx3DKn7UfmBMyov8ySvLRVldA==}
+
   '@types/node@20.17.17':
     resolution: {integrity: sha512-/WndGO4kIfMicEQLTi/mDANUu/iVUhT7KboZPdEqqHQ4aTS+3qT3U5gIqWDFV+XouorjfgGqvKILJeHhuQgFYg==}
 
@@ -229,6 +235,10 @@ packages:
     resolution: {integrity: sha512-jqdObeR2rxZZbPSGL+3VckHMYtu+f9//KXBsVny6JSX/pa38Fy+bGjuG8eW/H6USNQWhLi8Num++cU2yOCNz4A==}
     engines: {node: '>= 0.12'}
 
+  form-data@4.0.1:
+    resolution: {integrity: sha512-tzN8e4TX8+kkxGPK8D5u0FNmjPUjw3lwC9lSLxxoB/+GtsJG91CO8bSWy73APlgAZzZbXEYZJuxjkHH2w+Ezhw==}
+    engines: {node: '>= 6'}
+
   function-bind@1.1.2:
     resolution: {integrity: sha512-7XHNxH7qX9xG5mIwxkhumTox/MIRNcOgDrxWsMt2pAr23WHp6MrRlN7FBSFpCpr+oVO0F744iUgR82nJMfG2SA==}
 
@@ -539,6 +549,11 @@ snapshots:
 
   '@types/expand-tilde@2.0.2': {}
 
+  '@types/node-fetch@2.6.12':
+    dependencies:
+      '@types/node': 20.17.17
+      form-data: 4.0.1
+
   '@types/node@20.17.17':
     dependencies:
       undici-types: 6.19.8
@@ -627,6 +642,12 @@ snapshots:
       mime-types: 2.1.35
       safe-buffer: 5.2.1
 
+  form-data@4.0.1:
+    dependencies:
+      asynckit: 0.4.0
+      combined-stream: 1.0.8
+      mime-types: 2.1.35
+
   function-bind@1.1.2: {}
 
   get-intrinsic@1.3.0:

src/cache-restore/index.ts

@@ -1,19 +1,19 @@
-import { isFeatureAvailable } from '@actions/cache'
+import * as cache from '@actions/cache';
-import { endGroup, startGroup, warning } from '@actions/core'
+import * as core from '@actions/core';
-import { Inputs } from '../inputs'
+import { runRestoreCache } from './run';
-import { runRestoreCache } from './run'
+import { Inputs } from '../inputs';
 
 export async function restoreCache(inputs: Inputs) {
   if (!inputs.cache) return
 
-  if (!isFeatureAvailable()) {
+  if (!cache.isFeatureAvailable()) {
-    warning('Cache is not available, skipping cache restoration')
+    core.warning('Cache is not available, skipping cache restoration')
     return
   }
 
-  startGroup('Restoring cache...')
+  core.startGroup('Restoring cache...')
-  await runRestoreCache(inputs)
+  await runRestoreCache(inputs);
-  endGroup()
+  core.endGroup();
 }
 
 export default restoreCache

src/cache-restore/run.ts

@@ -1,39 +1,39 @@
-import { restoreCache } from '@actions/cache'
+import * as cache from '@actions/cache';
-import { debug, info, saveState, setOutput } from '@actions/core'
+import * as core from '@actions/core';
-import { getExecOutput } from '@actions/exec'
+import * as exec from '@actions/exec';
-import { hashFiles } from '@actions/glob'
+import * as glob from '@actions/glob';
-import os from 'os'
+import os from 'os';
-import { Inputs } from '../inputs'
+import { Inputs } from '../inputs';
 
 export async function runRestoreCache(inputs: Inputs) {
-  const cachePath = await getCacheDirectory()
+  const cachePath = await getCacheDirectory();
-  saveState('cache_path', cachePath)
+  core.saveState('cache_path', cachePath);
 
-  const fileHash = await hashFiles(inputs.cacheDependencyPath)
+  const fileHash = await glob.hashFiles(inputs.cacheDependencyPath);
   if (!fileHash) {
-    throw new Error('Some specified paths were not resolved, unable to cache dependencies.')
+    throw new Error('Some specified paths were not resolved, unable to cache dependencies.');
   }
 
-  const primaryKey = `pnpm-cache-${process.env.RUNNER_OS}-${os.arch()}-${fileHash}`
+  const primaryKey = `pnpm-cache-${process.env.RUNNER_OS}-${os.arch()}-${fileHash}`;
-  debug(`Primary key is ${primaryKey}`)
+  core.debug(`Primary key is ${primaryKey}`);
-  saveState('cache_primary_key', primaryKey)
+  core.saveState('cache_primary_key', primaryKey);
 
-  let cacheKey = await restoreCache([cachePath], primaryKey)
+  let cacheKey = await cache.restoreCache([cachePath], primaryKey);
 
-  setOutput('cache-hit', Boolean(cacheKey))
+  core.setOutput('cache-hit', Boolean(cacheKey));
 
   if (!cacheKey) {
-    info(`Cache is not found`)
+    core.info(`Cache is not found`);
-    return
+    return;
   }
 
-  saveState('cache_restored_key', cacheKey)
+  core.saveState('cache_restored_key', cacheKey)
-  info(`Cache restored from key: ${cacheKey}`)
+  core.info(`Cache restored from key: ${cacheKey}`)
 }
 
 async function getCacheDirectory() {
-  const { stdout } = await getExecOutput('pnpm store path --silent')
+  const { stdout } = await exec.getExecOutput('pnpm store path --silent')
   const cacheFolderPath = stdout.trim()
-  debug(`Cache folder is set to "${cacheFolderPath}"`)
+  core.debug(`Cache folder is set to "${cacheFolderPath}"`)
-  return cacheFolderPath
+  return cacheFolderPath;
-}
+};

src/cache-save/index.ts

@@ -1,14 +1,14 @@
-import { setFailed } from '@actions/core'
+import * as core from '@actions/core';
-import { Inputs } from '../inputs'
+import { Inputs } from '../inputs';
-import { runSaveCache } from './run'
+import { runSaveCache } from './run';
 
 export async function saveCache(inputs: Inputs) {
   if (!inputs.cache) return
 
   try {
-    await runSaveCache()
+    await runSaveCache();
   } catch (error) {
-    setFailed((error as Error).message)
+    core.setFailed((error as Error).message);
   }
 }
 

src/cache-save/run.ts

@@ -1,18 +1,18 @@
-import { saveCache } from '@actions/cache'
+import * as core from '@actions/core';
-import { getState, info } from '@actions/core'
+import * as cache from '@actions/cache';
 
 export async function runSaveCache() {
-  const state = getState('cache_restored_key')
+  const state = core.getState('cache_restored_key');
-  const primaryKey = getState('cache_primary_key')
+  const primaryKey = core.getState('cache_primary_key');
-  const cachePath = getState('cache_path')
+  const cachePath = core.getState('cache_path');
 
   if (primaryKey === state) {
-    info(`Cache hit occurred on the primary key ${primaryKey}, not saving cache.`)
+    core.info(`Cache hit occurred on the primary key ${primaryKey}, not saving cache.`);
-    return
+    return;
   }
 
-  const cacheId = await saveCache([cachePath], primaryKey)
+  const cacheId = await cache.saveCache([cachePath], primaryKey);
-  if (cacheId == -1) return
+  if (cacheId == -1) return;
 
-  info(`Cache saved with the key: ${primaryKey}`)
+  core.info(`Cache saved with the key: ${primaryKey}`);
 }

src/index.ts

@@ -1,11 +1,11 @@
 import { setFailed, saveState, getState } from '@actions/core'
-import restoreCache from './cache-restore'
-import saveCache from './cache-save'
 import getInputs, { Inputs } from './inputs'
 import installPnpm from './install-pnpm'
 import setOutputs from './outputs'
 import pnpmInstall from './pnpm-install'
 import pruneStore from './pnpm-store-prune'
+import restoreCache from './cache-restore'
+import saveCache from './cache-save'
 
 async function main() {
   const inputs = getInputs()
@@ -24,7 +24,7 @@ async function runMain(inputs: Inputs) {
   console.log('Installation Completed!')
   setOutputs(inputs)
 
-  await restoreCache(inputs)
+  await restoreCache(inputs);
 
   pnpmInstall(inputs)
 }

src/inputs/run-install.ts

@@ -1,5 +1,5 @@
 import { getInput, error } from '@actions/core'
-import { parse as parseYaml } from 'yaml'
+import * as yaml from 'yaml'
 import { z, ZodError } from 'zod'
 
 const RunInstallSchema = z.object({
@@ -20,7 +20,7 @@ export type RunInstall = z.infer<typeof RunInstallSchema>
 
 export function parseRunInstall(inputName: string): RunInstall[] {
   const input = getInput(inputName, { required: true })
-  const parsedInput: unknown = parseYaml(input)
+  const parsedInput: unknown = yaml.parse(input)
 
   try {
     const result: RunInstallInput = RunInstallInputSchema.parse(parsedInput)

src/install-pnpm/run.ts

@@ -6,7 +6,7 @@ import path from 'path'
 import { execPath } from 'process'
 import util from 'util'
 import { Inputs } from '../inputs'
-import { parse as parseYaml } from 'yaml'
+import YAML from 'yaml'
 
 export async function runSelfInstaller(inputs: Inputs): Promise<number> {
   const { version, dest, packageJsonFile, standalone } = inputs
@@ -63,7 +63,7 @@ async function readTarget(opts: {
     try {
       const content = readFileSync(path.join(GITHUB_WORKSPACE, packageJsonFile), 'utf8');
       ({ packageManager } = packageJsonFile.endsWith(".yaml")
-        ? parseYaml(content, { merge: true })
+        ? YAML.parse(content, { merge: true })
         : JSON.parse(content)
       )
     } catch (error: unknown) {