fix: not allow install multiple package manager (#161)

When a project has both npm and pnpm, using pnpm/action-setup will result in an error: `Multiple versions of pnpm specified`.

The previous implementation was only meant to avoid the "ERR_PNPM_BAD_PM_VERSION" error, but it did not take into account the situation of multiple different package managers.

Signed-off-by: Kevin Cui <bh@bugs.cc>

.gitattributes

@@ -1,2 +1,2 @@
 *	text=auto
-dist/index.js	-text
+/dist/index.js	binary

.github/FUNDING.yml

@@ -1,12 +1,2 @@
-# These are supported funding model platforms
+custom:
-
+  - https://opencollective.com/pnpm
-github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
-patreon: khai96_
-open_collective: # Collective unavailable
-ko_fi: # Replace with a single Ko-fi username
-tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
-community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
-liberapay: # Replace with a single Liberapay username
-issuehunt: # disabled
-otechie: # Replace with a single Otechie username
-custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

.github/dependabot.yml

@@ -0,0 +1,7 @@
+version: 2
+updates:
+  - package-ecosystem: github-actions
+    directory: "/"
+    schedule:
+      interval: weekly
+    open-pull-requests-limit: 10

.github/workflows/test.yaml

@@ -3,6 +3,7 @@ name: Test Action
 on:
   - push
   - pull_request
+  - workflow_dispatch
 
 jobs:
   test_default_inputs:
@@ -14,19 +15,19 @@ jobs:
       fail-fast: false
       matrix:
         pnpm:
-          - 4.11.1
+          - 9.15.5
         os:
           - ubuntu-latest
           - macos-latest
           - windows-latest
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
 
       - name: Run the action
         uses: ./
         with:
-          version: 4.11.1
+          version: 9.15.5
 
       - name: 'Test: which'
         run: which pnpm; which pnpx
@@ -34,8 +35,8 @@ jobs:
       - name: 'Test: install'
         run: pnpm install
 
-  test_explicit_inputs:
+  test_dest:
-    name: Test with explicit inputs
+    name: Test with dest
 
     runs-on: ${{ matrix.os }}
 
@@ -43,25 +44,132 @@ jobs:
       fail-fast: false
       matrix:
         pnpm:
-          - 4.11.1
+          - 9.15.5
         os:
           - ubuntu-latest
           - macos-latest
           - windows-latest
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
 
       - name: Run the action
         uses: ./
         with:
-          version: 4.11.1
+          version: 9.15.5
           dest: ~/test/pnpm
-          bin_dest: ~/test/pnpm/.bin
-          registry: http://registry.yarnpkg.com/
 
       - name: 'Test: which'
         run: which pnpm && which pnpx
 
       - name: 'Test: install'
         run: pnpm install
+
+  test_standalone:
+    name: Test with standalone
+
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      fail-fast: false
+      matrix:
+        os:
+          - ubuntu-latest
+          - macos-latest
+          - windows-latest
+
+        standalone:
+          - true
+          - false
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Run the action
+        uses: ./
+        with:
+          version: 9.15.0
+          standalone: ${{ matrix.standalone }}
+
+      - name: install Node.js
+        uses: actions/setup-node@v4
+        with:
+          # pnpm@7.0.0 is not compatible with Node.js 12
+          node-version: 12.22.12
+
+      - name: 'Test: which (pnpm)'
+        run: which pnpm
+
+      - name: 'Test: which (pnpx)'
+        if: matrix.standalone == false
+        run: which pnpx
+
+      - name: 'Test: install when standalone is true'
+        if: matrix.standalone
+        run: pnpm install
+
+      - name: 'Test: install when standalone is false'
+        if: matrix.standalone == false
+        # Since the default shell on windows runner is pwsh, we specify bash explicitly
+        shell: bash
+        run: |
+          if pnpm install; then
+            echo "pnpm install should fail"
+            exit 1
+          else
+            echo "pnpm install failed as expected"
+          fi
+
+  test_run_install:
+    name: 'Test with run_install (${{ matrix.run_install.name }}, ${{ matrix.os }})'
+
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      fail-fast: false
+      matrix:
+        pnpm:
+          - 9.15.5
+        os:
+          - ubuntu-latest
+          - macos-latest
+          - windows-latest
+        run_install:
+          - name: 'null'
+            value: 'null'
+          - name: 'empty object'
+            value: '{}'
+          - name: 'recursive'
+            value: |
+              recursive: true
+          - name: 'global'
+            value: |
+              args:
+                - --global
+                - --global-dir=./pnpm-global
+                - npm
+                - yarn
+          - name: 'array'
+            value: |
+              - {}
+              - recursive: true
+              - args:
+                - --global
+                - --global-dir=./pnpm-global
+                - npm
+                - yarn
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Run the action
+        uses: ./
+        with:
+          version: 9.15.5
+          run_install: ${{ matrix.run_install.value }}
+
+      - name: 'Test: which'
+        run: which pnpm; which pnpx
+
+      - name: 'Test: install'
+        run: pnpm install

.gitignore

@@ -2,9 +2,12 @@ node_modules
 *.log
 /dist/*
 !/dist/index.js
+!/dist/pnpm.cjs
+!/dist/worker.js
 tmp
 temp
 *.tmp
 *.temp
 tmp.*
 temp.*
+.pnpm-store

README.md

@@ -1,24 +1,56 @@
-# Setup PNPM
+> ## :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.
 
-Install PNPM package manager.
+# Setup pnpm
+
+Install pnpm package manager.
 
 ## Inputs
 
 ### `version`
 
-**Required** Version of PNPM to install.
+Version of pnpm to install.
+
+**Optional** when there is a [`packageManager` field in the `package.json`](https://nodejs.org/api/corepack.html).
+
+otherwise, this field is **required** It supports npm versioning scheme, it could be an exact version (such as `6.24.1`), or a version range (such as `6`, `6.x.x`, `6.24.x`, `^6.24.1`, `*`, etc.), or `latest`.
 
 ### `dest`
 
-**Optional** Where to store PNPM files.
+**Optional** Where to store pnpm files.
 
-### `bin_dest`
+### `run_install`
 
-**Optional** Where to store executables (`pnpm` and `pnpx` commands).
+**Optional** (_default:_ `null`) If specified, run `pnpm install`.
 
-### `registry`
+If `run_install` is either `null` or `false`, pnpm will not install any npm package.
 
-**Optional** Registry to download PNPM from.
+If `run_install` is `true`, pnpm will install dependencies recursively.
+
+If `run_install` is a YAML string representation of either an object or an array, pnpm will execute every install commands.
+
+#### `run_install.recursive`
+
+**Optional** (_type:_ `boolean`, _default:_ `false`) Whether to use `pnpm recursive install`.
+
+#### `run_install.cwd`
+
+**Optional** (_type:_ `string`) Working directory when run `pnpm [recursive] install`.
+
+#### `run_install.args`
+
+**Optional** (_type:_ `string[]`) Additional arguments after `pnpm [recursive] install`, e.g. `[--frozen-lockfile, --strict-peer-dependencies]`.
+
+### `package_json_file`
+
+**Optional** (_type:_ `string`, _default:_ `package.json`) File path to the `package.json`/[`package.yaml`](https://github.com/pnpm/pnpm/pull/1799) to read "packageManager" configuration.
+
+### `standalone`
+
+**Optional** (_type:_ `boolean`, _default:_ `false`) When set to true, [@pnpm/exe](https://www.npmjs.com/package/@pnpm/exe), which is a Node.js bundled package, will be installed, enabling using `pnpm` without Node.js.
+
+This is useful when you want to use a incompatible pair of Node.js and pnpm.
 
 ## Outputs
 
@@ -28,33 +60,106 @@ Expanded path of inputs#dest.
 
 ### `bin_dest`
 
-Expanded path of inputs#bin_dest.
+Location of `pnpm` and `pnpx` command.
 
 ## Usage example
 
+### 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:
   - push
   - pull_request
 
 jobs:
-  runs-on: ubuntu-latest
+  install:
+    runs-on: ubuntu-latest
 
-  steps:
+    steps:
-    - uses: actions/checkout@v2
+      - uses: pnpm/action-setup@v4
-
+        with:
-    - uses: pnpm/action-setup@v1.1.0
+          version: 10
-      with:
-        version: 4.11.1
-
-    - name: Install dependencies
-      run: pnpm install
 ```
 
+###  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
+
+```yaml
+on:
+  - push
+  - pull_request
+
+jobs:
+  install:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: pnpm/action-setup@v4
+        with:
+          version: 10
+          run_install: |
+            - recursive: true
+              args: [--frozen-lockfile, --strict-peer-dependencies]
+            - args: [--global, gulp, prettier, typescript]
+```
+
+### Use cache to reduce installation time
+
+```yaml
+on:
+  - push
+  - pull_request
+
+jobs:
+  cache-and-install:
+    runs-on: ubuntu-latest
+
+    steps:
+      - 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
+          cache: 'pnpm'
+
+      - name: Install dependencies
+        run: pnpm install
+```
+
+**Note:** You don't need to run `pnpm store prune` at the end; post-action has already taken care of that.
+
 ## Notes
 
 This action does not setup Node.js for you, use [actions/setup-node](https://github.com/actions/setup-node) yourself.
 
 ## License
 
-[MIT](https://git.io/JfclH) © [Hoàng Văn Khải](https://github.com/KSXGitHub/)
+[MIT](https://github.com/pnpm/action-setup/blob/master/LICENSE.md) © [Hoàng Văn Khải](https://github.com/KSXGitHub/)

action.yml

@@ -1,24 +1,34 @@
-name: Setup PNPM
+name: Setup pnpm
-description: Install PNPM package manager
+description: Install pnpm package manager
 branding:
   icon: package
   color: orange
 inputs:
   version:
-    description: Version of PNPM to install
+    description: Version of pnpm to install
-    required: true
+    required: false
   dest:
-    description: Where to store PNPM files
+    description: Where to store pnpm files
     required: false
     default: ~/setup-pnpm
+  run_install:
+    description: If specified, run `pnpm install`
+    required: false
+    default: 'null'
+  package_json_file:
+    description: File path to the package.json to read "packageManager" configuration
+    required: false
+    default: 'package.json'
+  standalone:
+    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: Where to store executables (pnpm and pnpx commands)
+    description: Location of `pnpm` and `pnpx` command
-    required: false
-    default: ~/setup-pnpm/.bin
-  registry:
-    description: Registry to download PNPM from
-    required: false
-    default: https://registry.npmjs.com
 runs:
-  using: node12
+  using: node20
   main: dist/index.js
+  post: dist/index.js

package.json

@@ -3,18 +3,21 @@
   "scripts": {
     "build:ncc": "ncc build --minify --no-source-map-register --no-cache dist/tsc/index.js --out dist/",
     "build": "tsc && pnpm run build:ncc",
-    "start": "pnpm run build && sh ./run.sh"
+    "start": "pnpm run build && sh ./run.sh",
+    "update-pnpm-dist": "pnpm install && cp ./node_modules/pnpm/dist/pnpm.cjs ./dist/pnpm.cjs && cp ./node_modules/pnpm/dist/worker.js ./dist/worker.js"
   },
   "dependencies": {
-    "node-fetch": "^2.6.0",
+    "@actions/core": "^1.10.1",
+    "@types/expand-tilde": "^2.0.2",
+    "@types/node": "^20.11.5",
+    "@types/node-fetch": "^2.6.11",
     "expand-tilde": "^2.0.2",
-    "@actions/core": "^1.2.4",
+    "yaml": "^2.3.4",
-    "@types/expand-tilde": "^2.0.0",
+    "zod": "^3.22.4"
-    "@types/node-fetch": "^2.5.7",
-    "@types/node": "^13.13.5"
   },
   "devDependencies": {
-    "typescript": "^3.8.3",
+    "@vercel/ncc": "^0.38.1",
-    "@zeit/ncc": "^0.22.1"
+    "pnpm": "^8.14.3",
+    "typescript": "^5.3.3"
   }
 }

pnpm-lock.yaml

@@ -1,122 +1,200 @@
-dependencies:
+lockfileVersion: '9.0'
-  '@actions/core': 1.2.4
+
-  '@types/expand-tilde': 2.0.0
+settings:
-  '@types/node': 13.13.5
+  autoInstallPeers: true
-  '@types/node-fetch': 2.5.7
+  excludeLinksFromLockfile: false
-  expand-tilde: 2.0.2
+
-  node-fetch: 2.6.0
+importers:
-devDependencies:
+
-  '@zeit/ncc': 0.22.1
+  .:
-  typescript: 3.8.3
-lockfileVersion: 5.1
-packages:
-  /@actions/core/1.2.4:
-    dev: false
-    resolution:
-      integrity: sha512-YJCEq8BE3CdN8+7HPZ/4DxJjk/OkZV2FFIf+DlZTC/4iBlzYCD5yjRR6eiOS5llO11zbRltIRuKAjMKaWTE6cg==
-  /@types/expand-tilde/2.0.0:
-    dev: false
-    resolution:
-      integrity: sha512-17h/6MRHoetV2QVUVnUfrmaFCXNIFJ3uDJmXlklX2xDtlEb1W0OXLgP+qwND2Ibg/PtQfQi0vx19KGuPayjLiw==
-  /@types/node-fetch/2.5.7:
     dependencies:
-      '@types/node': 13.13.5
+      '@actions/core':
-      form-data: 3.0.0
+        specifier: ^1.10.1
-    dev: false
+        version: 1.11.1
-    resolution:
+      '@types/expand-tilde':
-      integrity: sha512-o2WVNf5UhWRkxlf6eq+jMZDu7kjgpgJfl4xVNlvryc95O/6F2ld8ztKX+qu+Rjyet93WAWm5LjeX9H5FGkODvw==
+        specifier: ^2.0.2
-  /@types/node/13.13.5:
+        version: 2.0.2
-    dev: false
+      '@types/node':
-    resolution:
+        specifier: ^20.11.5
-      integrity: sha512-3ySmiBYJPqgjiHA7oEaIo2Rzz0HrOZ7yrNO5HWyaE5q0lQ3BppDZ3N53Miz8bw2I7gh1/zir2MGVZBvpb1zq9g==
+        version: 20.17.17
-  /@zeit/ncc/0.22.1:
+      '@types/node-fetch':
-    dev: true
+        specifier: ^2.6.11
+        version: 2.6.12
+      expand-tilde:
+        specifier: ^2.0.2
+        version: 2.0.2
+      yaml:
+        specifier: ^2.3.4
+        version: 2.7.0
+      zod:
+        specifier: ^3.22.4
+        version: 3.24.1
+    devDependencies:
+      '@vercel/ncc':
+        specifier: ^0.38.1
+        version: 0.38.3
+      pnpm:
+        specifier: ^8.14.3
+        version: 8.15.9
+      typescript:
+        specifier: ^5.3.3
+        version: 5.7.3
+
+packages:
+
+  '@actions/core@1.11.1':
+    resolution: {integrity: sha512-hXJCSrkwfA46Vd9Z3q4cpEpHB1rL5NG04+/rbqW9d3+CSvtB1tYe8UTpAlixa1vj0m/ULglfEK2UKxMGxCxv5A==}
+
+  '@actions/exec@1.1.1':
+    resolution: {integrity: sha512-+sCcHHbVdk93a0XT19ECtO/gIXoxvdsgQLzb2fE2/5sIZmWQuluYyjPQtrtTHdU1YzTZ7bAPN4sITq2xi1679w==}
+
+  '@actions/http-client@2.1.0':
+    resolution: {integrity: sha512-BonhODnXr3amchh4qkmjPMUO8mFi/zLaaCeCAJZqch8iQqyDnVIkySjB38VHAC8IJ+bnlgfOqlhpyCUZHlQsqw==}
+
+  '@actions/io@1.1.3':
+    resolution: {integrity: sha512-wi9JjgKLYS7U/z8PPbco+PvTb/nRWjeoFlJ1Qer83k/3C5PHQi28hiVdeE2kHXmIL99mQFawx8qt/JPjZilJ8Q==}
+
+  '@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==}
+
+  '@vercel/ncc@0.38.3':
+    resolution: {integrity: sha512-rnK6hJBS6mwc+Bkab+PGPs9OiS0i/3kdTO+CkI8V0/VrW3vmz7O2Pxjw/owOlmo6PKEIxRSeZKv/kuL9itnpYA==}
     hasBin: true
-    resolution:
+
-      integrity: sha512-Qq3bMuonkcnV/96jhy9SQYdh39NXHxNMJ1O31ZFzWG9n52fR2DLtgrNzhj/ahlEjnBziMLGVWDbaS9sf03/fEw==
+  asynckit@0.4.0:
-  /asynckit/0.4.0:
+    resolution: {integrity: sha512-Oei9OH4tRh0YqU3GxhX79dM/mwVgvbZJaSNaRk+bshkj0S5cfHcgYakreBjrHwatXKbz+IoIdYLxrKim2MjW0Q==}
-    dev: false
+
-    resolution:
+  combined-stream@1.0.8:
-      integrity: sha1-x57Zf380y48robyXkLzDZkdLS3k=
+    resolution: {integrity: sha512-FQN4MRfuJeHf7cBbBMJFXhKSDq+2kAArBlmRBvcvFE5BB1HZKXtSFASDhdlz9zOYwxh8lDdnvmMOe/+5cdoEdg==}
-  /combined-stream/1.0.8:
+    engines: {node: '>= 0.8'}
+
+  delayed-stream@1.0.0:
+    resolution: {integrity: sha512-ZySD7Nf91aLB0RxL4KGrKHBXl7Eds1DAmEdcoVawXnLD7SDhpNgtuII2aAkg7a7QS41jxPSZ17p4VdGnMHk3MQ==}
+    engines: {node: '>=0.4.0'}
+
+  expand-tilde@2.0.2:
+    resolution: {integrity: sha512-A5EmesHW6rfnZ9ysHQjPdJRni0SRar0tjtG5MNtm9n5TUvsYU8oozprtRD4AqHxcZWWlVuAmQo2nWKfN9oyjTw==}
+    engines: {node: '>=0.10.0'}
+
+  form-data@4.0.1:
+    resolution: {integrity: sha512-tzN8e4TX8+kkxGPK8D5u0FNmjPUjw3lwC9lSLxxoB/+GtsJG91CO8bSWy73APlgAZzZbXEYZJuxjkHH2w+Ezhw==}
+    engines: {node: '>= 6'}
+
+  homedir-polyfill@1.0.3:
+    resolution: {integrity: sha512-eSmmWE5bZTK2Nou4g0AI3zZ9rswp7GRKoKXS1BLUkvPviOqs4YTN1djQIqrXy9k5gEtdLPy86JjRwsNM9tnDcA==}
+    engines: {node: '>=0.10.0'}
+
+  mime-db@1.52.0:
+    resolution: {integrity: sha512-sPU4uV7dYlvtWJxwwxHD0PuihVNiE7TyAbQ5SWxDCB9mUYvOgroQOwYQQOKPJ8CIbE+1ETVlOoK1UC2nU3gYvg==}
+    engines: {node: '>= 0.6'}
+
+  mime-types@2.1.35:
+    resolution: {integrity: sha512-ZDY+bPm5zTTF+YpCrAU9nK0UgICYPT0QtT1NZWFv4s++TNkcgVaT0g6+4R2uI4MjQjzysHB1zxuWL50hzaeXiw==}
+    engines: {node: '>= 0.6'}
+
+  parse-passwd@1.0.0:
+    resolution: {integrity: sha512-1Y1A//QUXEZK7YKz+rD9WydcE1+EuPr6ZBgKecAB8tmoW6UFv0NREVJe1p+jRxtThkcbbKkfwIbWJe/IeE6m2Q==}
+    engines: {node: '>=0.10.0'}
+
+  pnpm@8.15.9:
+    resolution: {integrity: sha512-SZQ0ydj90aJ5Tr9FUrOyXApjOrzuW7Fee13pDzL0e1E6ypjNXP0AHDHw20VLw4BO3M1XhQHkyik6aBYWa72fgQ==}
+    engines: {node: '>=16.14'}
+    hasBin: true
+
+  tunnel@0.0.6:
+    resolution: {integrity: sha512-1h/Lnq9yajKY2PEbBadPXj3VxsDDu844OnaAo52UVmIzIvwwtBPIuNvkjuzBlTWpfJyUbG3ez0KSBibQkj4ojg==}
+    engines: {node: '>=0.6.11 <=0.7.0 || >=0.7.3'}
+
+  typescript@5.7.3:
+    resolution: {integrity: sha512-84MVSjMEHP+FQRPy3pX9sTVV/INIex71s9TL2Gm5FG/WG1SqXeKyZ0k7/blY/4FdOzI12CBy1vGc4og/eus0fw==}
+    engines: {node: '>=14.17'}
+    hasBin: true
+
+  undici-types@6.19.8:
+    resolution: {integrity: sha512-ve2KP6f/JnbPBFyobGHuerC9g1FYGn/F8n1LWTwNxCEzd6IfqTwUQcNXgEtmmQ6DlRrC1hrSrBnCZPokRrDHjw==}
+
+  yaml@2.7.0:
+    resolution: {integrity: sha512-+hSoy/QHluxmC9kCIJyL/uyFmLmc+e5CFR5Wa+bpIhIj85LVb9ZH2nVnqrHoSvKogwODv0ClqZkmiSSaIH5LTA==}
+    engines: {node: '>= 14'}
+    hasBin: true
+
+  zod@3.24.1:
+    resolution: {integrity: sha512-muH7gBL9sI1nciMZV67X5fTKKBLtwpZ5VBp1vsOQzj1MhrBZ4wlVCm3gedKZWLp0Oyel8sIGfeiz54Su+OVT+A==}
+
+snapshots:
+
+  '@actions/core@1.11.1':
+    dependencies:
+      '@actions/exec': 1.1.1
+      '@actions/http-client': 2.1.0
+
+  '@actions/exec@1.1.1':
+    dependencies:
+      '@actions/io': 1.1.3
+
+  '@actions/http-client@2.1.0':
+    dependencies:
+      tunnel: 0.0.6
+
+  '@actions/io@1.1.3': {}
+
+  '@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
+
+  '@vercel/ncc@0.38.3': {}
+
+  asynckit@0.4.0: {}
+
+  combined-stream@1.0.8:
     dependencies:
       delayed-stream: 1.0.0
-    dev: false
+
-    engines:
+  delayed-stream@1.0.0: {}
-      node: '>= 0.8'
+
-    resolution:
+  expand-tilde@2.0.2:
-      integrity: sha512-FQN4MRfuJeHf7cBbBMJFXhKSDq+2kAArBlmRBvcvFE5BB1HZKXtSFASDhdlz9zOYwxh8lDdnvmMOe/+5cdoEdg==
-  /delayed-stream/1.0.0:
-    dev: false
-    engines:
-      node: '>=0.4.0'
-    resolution:
-      integrity: sha1-3zrhmayt+31ECqrgsp4icrJOxhk=
-  /expand-tilde/2.0.2:
     dependencies:
       homedir-polyfill: 1.0.3
-    dev: false
+
-    engines:
+  form-data@4.0.1:
-      node: '>=0.10.0'
-    resolution:
-      integrity: sha1-l+gBqgUt8CRU3kawK/YhZCzchQI=
-  /form-data/3.0.0:
     dependencies:
       asynckit: 0.4.0
       combined-stream: 1.0.8
-      mime-types: 2.1.27
+      mime-types: 2.1.35
-    dev: false
+
-    engines:
+  homedir-polyfill@1.0.3:
-      node: '>= 6'
-    resolution:
-      integrity: sha512-CKMFDglpbMi6PyN+brwB9Q/GOw0eAnsrEZDgcsH5Krhz5Od/haKHAX0NmQfha2zPPz0JpWzA7GJHGSnvCRLWsg==
-  /homedir-polyfill/1.0.3:
     dependencies:
       parse-passwd: 1.0.0
-    dev: false
+
-    engines:
+  mime-db@1.52.0: {}
-      node: '>=0.10.0'
+
-    resolution:
+  mime-types@2.1.35:
-      integrity: sha512-eSmmWE5bZTK2Nou4g0AI3zZ9rswp7GRKoKXS1BLUkvPviOqs4YTN1djQIqrXy9k5gEtdLPy86JjRwsNM9tnDcA==
-  /mime-db/1.44.0:
-    dev: false
-    engines:
-      node: '>= 0.6'
-    resolution:
-      integrity: sha512-/NOTfLrsPBVeH7YtFPgsVWveuL+4SjjYxaQ1xtM1KMFj7HdxlBlxeyNLzhyJVx7r4rZGJAZ/6lkKCitSc/Nmpg==
-  /mime-types/2.1.27:
     dependencies:
-      mime-db: 1.44.0
+      mime-db: 1.52.0
-    dev: false
+
-    engines:
+  parse-passwd@1.0.0: {}
-      node: '>= 0.6'
+
-    resolution:
+  pnpm@8.15.9: {}
-      integrity: sha512-JIhqnCasI9yD+SsmkquHBxTSEuZdQX5BuQnS2Vc7puQQQ+8yiP5AY5uWhpdv4YL4VM5c6iliiYWPgJ/nJQLp7w==
+
-  /node-fetch/2.6.0:
+  tunnel@0.0.6: {}
-    dev: false
+
-    engines:
+  typescript@5.7.3: {}
-      node: 4.x || >=6.0.0
+
-    resolution:
+  undici-types@6.19.8: {}
-      integrity: sha512-8dG4H5ujfvFiqDmVu9fQ5bOHUC15JMjMY/Zumv26oOvvVJjM67KF8koCWIabKQ1GJIa9r2mMZscBq/TbdOcmNA==
+
-  /parse-passwd/1.0.0:
+  yaml@2.7.0: {}
-    dev: false
+
-    engines:
+  zod@3.24.1: {}
-      node: '>=0.10.0'
-    resolution:
-      integrity: sha1-bVuTSkVpk7I9N/QKOC1vFmao5cY=
-  /typescript/3.8.3:
-    dev: true
-    engines:
-      node: '>=4.2.0'
-    hasBin: true
-    resolution:
-      integrity: sha512-MYlEfn5VrLNsgudQTVJeNaQFUAI7DkhnOjdpAp4T+ku1TfQClewlbSuTVHiA+8skNBgaf02TL/kLOvig4y3G8w==
-specifiers:
-  '@actions/core': ^1.2.4
-  '@types/expand-tilde': ^2.0.0
-  '@types/node': ^13.13.5
-  '@types/node-fetch': ^2.5.7
-  '@zeit/ncc': ^0.22.1
-  expand-tilde: ^2.0.2
-  node-fetch: ^2.6.0
-  typescript: ^3.8.3

renovate.json

@@ -1,6 +1,10 @@
 {
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
   "pinVersions": false,
   "extends": [
     "config:base"
+  ],
+  "ignoreDeps": [
+    "ajv"
   ]
 }

run.sh

@@ -3,6 +3,6 @@
 export HOME="$(pwd)"
 export INPUT_VERSION=4.11.1
 export INPUT_DEST='~/pnpm.temp'
-export INPUT_BIN_DEST='~/pnpm.temp/.bin'
+export INPUT_RUN_INSTALL=null
-export INPUT_REGISTRY=https://registry.npmjs.com
+export INPUT_standalone=false
 exec node dist/index.js

src/index.ts

@@ -1,14 +1,19 @@
-import { setFailed } from '@actions/core'
+import { setFailed, saveState, getState } from '@actions/core'
 import getInputs from './inputs'
+import installPnpm from './install-pnpm'
 import setOutputs from './outputs'
-import install from './install'
+import pnpmInstall from './pnpm-install'
+import pruneStore from './pnpm-store-prune'
 
 async function main() {
   const inputs = getInputs()
-  await install(inputs).then(() => {
+  const isPost = getState('is_post')
-    console.log('Installation Completed!')
+  if (isPost === 'true') return pruneStore(inputs)
-    setOutputs(inputs)
+  saveState('is_post', 'true')
-  })
+  await installPnpm(inputs)
+  console.log('Installation Completed!')
+  setOutputs(inputs)
+  pnpmInstall(inputs)
 }
 
 main().catch(error => {

src/inputs/index.ts

@@ -1,11 +1,13 @@
-import { getInput, InputOptions } from '@actions/core'
+import { getBooleanInput, getInput, InputOptions } from '@actions/core'
 import expandTilde from 'expand-tilde'
+import { RunInstall, parseRunInstall } from './run-install'
 
 export interface Inputs {
-  readonly version: string
+  readonly version?: string
   readonly dest: string
-  readonly binDest: string
+  readonly runInstall: RunInstall[]
-  readonly registry: string
+  readonly packageJsonFile: string
+  readonly standalone: boolean
 }
 
 const options: InputOptions = {
@@ -15,10 +17,11 @@ const options: InputOptions = {
 const parseInputPath = (name: string) => expandTilde(getInput(name, options))
 
 export const getInputs = (): Inputs => ({
-  version: getInput('version', options),
+  version: getInput('version'),
   dest: parseInputPath('dest'),
-  binDest: parseInputPath('bin_dest'),
+  runInstall: parseRunInstall('run_install'),
-  registry: getInput('registry', options),
+  packageJsonFile: parseInputPath('package_json_file'),
+  standalone: getBooleanInput('standalone'),
 })
 
 export default getInputs

src/inputs/run-install.ts

@@ -0,0 +1,41 @@
+import { getInput, error } from '@actions/core'
+import * as yaml from 'yaml'
+import { z, ZodError } from 'zod'
+
+const RunInstallSchema = z.object({
+  recursive: z.boolean().optional(),
+  cwd: z.string().optional(),
+  args: z.array(z.string()).optional(),
+})
+
+const RunInstallInputSchema = z.union([
+  z.null(),
+  z.boolean(),
+  RunInstallSchema,
+  z.array(RunInstallSchema),
+])
+
+export type RunInstallInput = z.infer<typeof RunInstallInputSchema>
+export type RunInstall = z.infer<typeof RunInstallSchema>
+
+export function parseRunInstall(inputName: string): RunInstall[] {
+  const input = getInput(inputName, { required: true })
+  const parsedInput: unknown = yaml.parse(input)
+
+  try {
+    const result: RunInstallInput = RunInstallInputSchema.parse(parsedInput)
+    if (!result) return []
+    if (result === true) return [{ recursive: true }]
+    if (Array.isArray(result)) return result
+    return [result]
+  } catch (exception: unknown) {
+    error(`Error for input "${inputName}" = ${input}`)
+
+    if (exception instanceof ZodError) {
+      error(`Errors: ${exception.errors}`)
+    } else {
+      error(`Exception: ${exception}`)
+    }
+    process.exit(1)
+  }
+}

src/install-pnpm/index.ts

@@ -1,13 +1,15 @@
-import { setFailed } from '@actions/core'
+import { setFailed, startGroup, endGroup } from '@actions/core'
 import { Inputs } from '../inputs'
 import runSelfInstaller from './run'
 
 export { runSelfInstaller }
 
 export async function install(inputs: Inputs) {
+  startGroup('Running self-installer...')
   const status = await runSelfInstaller(inputs)
+  endGroup()
   if (status) {
-    return setFailed(`Something does wrong, self-installer exits with code ${status}`)
+    return setFailed(`Something went wrong, self-installer exits with code ${status}`)
   }
 }
 

src/install-pnpm/run.ts

@@ -0,0 +1,104 @@
+import { addPath, exportVariable } from '@actions/core'
+import { spawn } from 'child_process'
+import { rm, writeFile, mkdir } from 'fs/promises'
+import { readFileSync } from 'fs'
+import path from 'path'
+import { execPath } from 'process'
+import util from 'util'
+import { Inputs } from '../inputs'
+import YAML from 'yaml'
+
+export async function runSelfInstaller(inputs: Inputs): Promise<number> {
+  const { version, dest, packageJsonFile, standalone } = inputs
+
+  // prepare self install
+  await rm(dest, { recursive: true, force: true })
+  // create dest directory after removal
+  await mkdir(dest, { recursive: true })
+  const pkgJson = path.join(dest, 'package.json')
+  // we have ensured the dest directory exists, we can write the file directly
+  await writeFile(pkgJson, JSON.stringify({ private: true }))
+
+  // prepare target pnpm
+  const target = await readTarget({ version, packageJsonFile, standalone })
+  const cp = spawn(execPath, [path.join(__dirname, 'pnpm.cjs'), 'install', target, '--no-lockfile'], {
+    cwd: dest,
+    stdio: ['pipe', 'inherit', 'inherit'],
+  })
+
+  const exitCode = await new Promise<number>((resolve, reject) => {
+    cp.on('error', reject)
+    cp.on('close', resolve)
+  })
+  if (exitCode === 0) {
+    const pnpmHome = path.join(dest, 'node_modules/.bin')
+    addPath(pnpmHome)
+    exportVariable('PNPM_HOME', pnpmHome)
+  }
+  return exitCode
+}
+
+async function readTarget(opts: {
+  readonly version?: string | undefined
+  readonly packageJsonFile: string
+  readonly standalone: boolean
+}) {
+  const { version, packageJsonFile, standalone } = opts
+  const { GITHUB_WORKSPACE } = process.env
+
+  let packageManager
+
+  if (GITHUB_WORKSPACE) {
+    try {
+      const content = readFileSync(path.join(GITHUB_WORKSPACE, packageJsonFile), 'utf8');
+      ({ packageManager } = packageJsonFile.endsWith(".yaml")
+        ? YAML.parse(content, { merge: true })
+        : JSON.parse(content)
+      )
+    } catch (error: unknown) {
+      // Swallow error if package.json doesn't exist in root
+      if (!util.types.isNativeError(error) || !('code' in error) || error.code !== 'ENOENT') throw error
+    }
+  }
+
+  if (version) {
+    if (
+      typeof packageManager === 'string' &&
+      packageManager.startsWith('pnpm@') &&
+      packageManager.replace('pnpm@', '') !== version
+    ) {
+      throw new Error(`Multiple versions of pnpm specified:
+  - version ${version} in the GitHub Action config with the key "version"
+  - version ${packageManager} in the package.json with the key "packageManager"
+Remove one of these versions to avoid version mismatch errors like ERR_PNPM_BAD_PM_VERSION`)
+    }
+
+    return `${ standalone ? '@pnpm/exe' : 'pnpm' }@${version}`
+  }
+
+  if (!GITHUB_WORKSPACE) {
+    throw new Error(`No workspace is found.
+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.
+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@')) {
+    throw new Error('Invalid packageManager field in package.json')
+  }
+
+  if (standalone) {
+    return packageManager.replace('pnpm@', '@pnpm/exe@')
+  }
+
+  return packageManager
+}
+
+export default runSelfInstaller

src/install/run.ts

@@ -1,26 +0,0 @@
-import { spawn } from 'child_process'
-import { execPath } from 'process'
-import { downloadSelfInstaller } from '../self-installer'
-import { Inputs } from '../inputs'
-
-export async function runSelfInstaller(inputs: Inputs): Promise<number> {
-  const cp = spawn(execPath, {
-    env: {
-      PNPM_VERSION: inputs.version,
-      PNPM_DEST: inputs.dest,
-      PNPM_BIN_DEST: inputs.binDest,
-      PNPM_REGISTRY: inputs.registry,
-    },
-    stdio: ['pipe', 'inherit', 'inherit'],
-  })
-
-  const response = await downloadSelfInstaller()
-  response.body.pipe(cp.stdin)
-
-  return new Promise((resolve, reject) => {
-    cp.on('error', reject)
-    cp.on('close', resolve)
-  })
-}
-
-export default runSelfInstaller

src/outputs/index.ts

@@ -1,10 +1,12 @@
 import { setOutput, addPath } from '@actions/core'
 import { Inputs } from '../inputs'
+import { getBinDest } from '../utils'
 
 export function setOutputs(inputs: Inputs) {
-  addPath(inputs.binDest)
+  const binDest = getBinDest(inputs)
+  addPath(binDest)
   setOutput('dest', inputs.dest)
-  setOutput('bin_dest', inputs.binDest)
+  setOutput('bin_dest', binDest)
 }
 
 export default setOutputs

src/pnpm-install/index.ts

@@ -0,0 +1,38 @@
+import { setFailed, startGroup, endGroup } from '@actions/core'
+import { spawnSync } from 'child_process'
+import { Inputs } from '../inputs'
+import { patchPnpmEnv } from '../utils'
+
+export function runPnpmInstall(inputs: Inputs) {
+  const env = patchPnpmEnv(inputs)
+
+  for (const options of inputs.runInstall) {
+    const args = ['install']
+    if (options.recursive) args.unshift('recursive')
+    if (options.args) args.push(...options.args)
+
+    const cmdStr = ['pnpm', ...args].join(' ')
+    startGroup(`Running ${cmdStr}...`)
+
+    const { error, status } = spawnSync('pnpm', args, {
+      stdio: 'inherit',
+      cwd: options.cwd,
+      shell: true,
+      env,
+    })
+
+    endGroup()
+
+    if (error) {
+      setFailed(error)
+      continue
+    }
+
+    if (status) {
+      setFailed(`Command ${cmdStr} (cwd: ${options.cwd}) exits with status ${status}`)
+      continue
+    }
+  }
+}
+
+export default runPnpmInstall

src/pnpm-store-prune/index.ts

@@ -0,0 +1,31 @@
+import { warning, startGroup, endGroup } from '@actions/core'
+import { spawnSync } from 'child_process'
+import { Inputs } from '../inputs'
+import { patchPnpmEnv } from '../utils'
+
+export function pruneStore(inputs: Inputs) {
+  if (inputs.runInstall.length === 0) {
+    console.log('Pruning is unnecessary.')
+    return
+  }
+
+  startGroup('Running pnpm store prune...')
+  const { error, status } = spawnSync('pnpm', ['store', 'prune'], {
+    stdio: 'inherit',
+    shell: true,
+    env: patchPnpmEnv(inputs),
+  })
+  endGroup()
+
+  if (error) {
+    warning(error)
+    return
+  }
+
+  if (status) {
+    warning(`command pnpm store prune exits with code ${status}`)
+    return
+  }
+}
+
+export default pruneStore

src/self-installer/download.ts

@@ -1,4 +0,0 @@
-import fetch from 'node-fetch'
-import url from './url'
-export const downloadSelfInstaller = () => fetch(url)
-export default downloadSelfInstaller

src/self-installer/index.ts

@@ -1,2 +0,0 @@
-export * from './url'
-export * from './download'

src/self-installer/url.ts

@@ -1,3 +0,0 @@
-export const ref = '301414cec74a2b6b63c95b42f2ad1790ccb980ed'
-export const url = `https://raw.githubusercontent.com/pnpm/self-installer/${ref}/install.js`
-export default url

src/utils/index.ts

@@ -0,0 +1,10 @@
+import path from 'path'
+import process from 'process'
+import { Inputs } from '../inputs'
+
+export const getBinDest = (inputs: Inputs): string => path.join(inputs.dest, 'node_modules', '.bin')
+
+export const patchPnpmEnv = (inputs: Inputs): NodeJS.ProcessEnv => ({
+  ...process.env,
+  PATH: getBinDest(inputs) + path.delimiter + process.env.PATH,
+})

tsconfig.json

@@ -1,15 +1,11 @@
 
 {
   "compilerOptions": {
-    "target": "ES2018",
+    "target": "ES2022",
-    "module": "CommonJS",
+    "module": "Node16",
-    "moduleResolution": "Node",
     "resolveJsonModule": true,
     "lib": [
-      "ES2018",
+      "ES2023"
-      "ES2019",
-      "ES2020",
-      "ESNext"
     ],
     "outDir": "./dist/tsc",
     "preserveConstEnums": true,