Merge d5bd7e8c9a into e303250a24

* Add readme example for omitting `version`

* docs: more detailed explanations

---------

Co-authored-by: Khải <hvksmr1996@gmail.com>

README.md

@@ -1,3 +1,7 @@
+> ## :warning: Upgrade from v2!
+>
+> The v2 version of this action [has stopped working](https://github.com/pnpm/action-setup/issues/135) with newer Node.js versions. Please, upgrade to the latest version to fix any issues.
+
 # Setup pnpm
 
 Install pnpm package manager.
@@ -60,7 +64,9 @@ Location of `pnpm` and `pnpx` command.
 
 ## Usage example
 
-### Just install pnpm
+### Install only pnpm without `packageManager`
+
+This works when the repo either doesn't have a `package.json` or has a `package.json` but it doesn't specify `packageManager`.
 
 ```yaml
 on:
@@ -74,7 +80,24 @@ jobs:
     steps:
       - uses: pnpm/action-setup@v4
         with:
-          version: 8
+          version: 10
+```
+
+###  Install only pnpm with `packageManager`
+
+Omit `version` input to use the version in the [`packageManager` field in the `package.json`](https://nodejs.org/api/corepack.html).
+
+```yaml
+on:
+  - push
+  - pull_request
+
+jobs:
+  install:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: pnpm/action-setup@v4
 ```
 
 ### Install pnpm and a few npm packages
@@ -93,7 +116,7 @@ jobs:
 
       - uses: pnpm/action-setup@v4
         with:
-          version: 8
+          version: 10
           run_install: |
             - recursive: true
               args: [--frozen-lockfile, --strict-peer-dependencies]
@@ -115,29 +138,17 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v4
 
+      - uses: pnpm/action-setup@v4
+        name: Install pnpm
+        with:
+          version: 10
+          run_install: false
+
       - name: Install Node.js
         uses: actions/setup-node@v4
         with:
           node-version: 20
-
-      - uses: pnpm/action-setup@v4
-        name: Install pnpm
-        with:
-          version: 8
-          run_install: false
-
-      - name: Get pnpm store directory
-        shell: bash
-        run: |
-          echo "STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV
-
-      - uses: actions/cache@v4
-        name: Setup pnpm cache
-        with:
-          path: ${{ env.STORE_PATH }}
-          key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
-          restore-keys: |
-            ${{ runner.os }}-pnpm-store-
+          cache: 'pnpm'
 
       - name: Install dependencies
         run: pnpm install

action.yml

@@ -23,6 +23,11 @@ inputs:
     description: When set to true, @pnpm/exe, which is a Node.js bundled package, will be installed, enabling using pnpm without Node.js.
     required: false
     default: 'false'
+outputs:
+  dest:
+    description: Expanded path of inputs#dest
+  bin_dest:
+    description: Location of `pnpm` and `pnpx` command
 runs:
   using: node20
   main: dist/index.js

src/install-pnpm/run.ts

@@ -5,6 +5,7 @@ import { readFileSync } from 'fs'
 import path from 'path'
 import { execPath } from 'process'
 import util from 'util'
+import * as yaml from 'yaml'
 import { Inputs } from '../inputs'
 
 export async function runSelfInstaller(inputs: Inputs): Promise<number> {
@@ -72,16 +73,24 @@ Remove one of these versions to avoid version mismatch errors like ERR_PNPM_BAD_
 
   if (!GITHUB_WORKSPACE) {
     throw new Error(`No workspace is found.
-If you're intended to let pnpm/action-setup read preferred pnpm version from the "packageManager" field in the package.json file,
+If you've intended to let pnpm/action-setup read preferred pnpm version from the "packageManager" field in the package.json file,
 please run the actions/checkout before pnpm/action-setup.
 Otherwise, please specify the pnpm version in the action configuration.`)
   }
 
   if (typeof packageManager !== 'string') {
-    throw new Error(`No pnpm version is specified.
+    if (GITHUB_WORKSPACE) {
+      try {
+        const { lockfileVersion } = yaml.parse(readFileSync(path.join(GITHUB_WORKSPACE, 'pnpm-lock.yaml'), 'utf8'))
+        const version = getPnpmVersionFromLockfile(lockfileVersion);
+        return `${ standalone ? '@pnpm/exe' : 'pnpm' }@${version}`
+      } catch (error: unknown) {
+        throw new Error(`No pnpm version is specified.
 Please specify it by one of the following ways:
   - in the GitHub Action config with the key "version"
   - in the package.json with the key "packageManager"`)
+      }
+    }
   }
 
   if (!packageManager.startsWith('pnpm@')) {
@@ -95,4 +104,21 @@ Please specify it by one of the following ways:
   return packageManager
 }
 
+function getPnpmVersionFromLockfile(
+  lockfileVersion: string | undefined
+): string | undefined {
+  switch (true) {
+    case lockfileVersion === '5.3':
+      return 'latest-6';
+    case lockfileVersion === '5.4':
+      return 'latest-7';
+    case lockfileVersion === '6.0' || lockfileVersion === '6.1':
+      return 'latest-8';
+    case lockfileVersion === '7.0' || lockfileVersion === '9.0':
+      return 'latest-9';
+    default:
+      return undefined;
+  }
+}
+
 export default runSelfInstaller