mirror of
https://github.com/pnpm/action-setup.git
synced 2025-04-20 10:29:59 +08:00
Compare commits
142 Commits
Author | SHA1 | Date | |
---|---|---|---|
![]() |
d648c2dd06 | ||
![]() |
a7487c7e89 | ||
![]() |
fff70888d0 | ||
![]() |
6e3017af18 | ||
![]() |
0cb0538c33 | ||
![]() |
e303250a24 | ||
![]() |
ac5bf11548 | ||
![]() |
18ac635edf | ||
![]() |
0d0b43217a | ||
![]() |
0eb0e97082 | ||
![]() |
23657c8550 | ||
![]() |
5d79380f29 | ||
![]() |
562dbbf611 | ||
![]() |
00884bcdc5 | ||
![]() |
fe02b34f77 | ||
![]() |
bee1f099e5 | ||
![]() |
ce859e384f | ||
![]() |
2ab6dce4f5 | ||
![]() |
e280758d01 | ||
![]() |
129abb77bf | ||
![]() |
a3252b78c4 | ||
![]() |
1ee9c9d01d | ||
![]() |
ebcfd6995d | ||
![]() |
d2613e087f | ||
![]() |
d928be8e0c | ||
![]() |
d882d12c64 | ||
![]() |
0b715c7ebb | ||
![]() |
2ed49cbb02 | ||
![]() |
218cb35941 | ||
![]() |
3723f63bb4 | ||
![]() |
849d884800 | ||
![]() |
f92eb0edb6 | ||
![]() |
b27f801bf9 | ||
![]() |
11dd14d0c0 | ||
![]() |
61eb8c655a | ||
![]() |
65db188e28 | ||
![]() |
0609f0983b | ||
![]() |
7208fa2733 | ||
![]() |
1bd00a2972 | ||
![]() |
d5601fb603 | ||
![]() |
bc06aa6030 | ||
![]() |
cd2af74528 | ||
![]() |
c8a150e137 | ||
![]() |
ed0172a253 | ||
![]() |
c3b53f6a16 | ||
![]() |
21e88da200 | ||
![]() |
fc3334fa11 | ||
![]() |
d01953a678 | ||
![]() |
3360b50db7 | ||
![]() |
6f9e9a867a | ||
![]() |
537643d491 | ||
![]() |
f4129fb46e | ||
![]() |
6e1964dde3 | ||
![]() |
10693b3829 | ||
![]() |
99ecd24520 | ||
![]() |
958500fcab | ||
![]() |
57b9359b4c | ||
![]() |
ec1a8b444c | ||
![]() |
73e15250cb | ||
![]() |
10b4b0b462 | ||
![]() |
5fa8980bf4 | ||
![]() |
ae78e9abbe | ||
![]() |
35ab4267a1 | ||
![]() |
11ba3424e0 | ||
![]() |
847a737d63 | ||
![]() |
225f3bb4b0 | ||
![]() |
777a50d72e | ||
![]() |
e7c10c6fc5 | ||
![]() |
a576a70bc6 | ||
![]() |
1d51e20937 | ||
![]() |
ad2b35ae0c | ||
![]() |
d8ea532ac4 | ||
![]() |
2270f39ef6 | ||
![]() |
394c848db6 | ||
![]() |
e13928ccc5 | ||
![]() |
93bd5a123d | ||
![]() |
9eb14dd77c | ||
![]() |
eafb777c56 | ||
![]() |
e6378df420 | ||
![]() |
6ff6e97bc6 | ||
![]() |
45d9c91ff6 | ||
![]() |
15569a497d | ||
![]() |
d70eebd14a | ||
![]() |
3bf8acf16f | ||
![]() |
3c2fe8c592 | ||
![]() |
76cc04cd5e | ||
![]() |
bcad811784 | ||
![]() |
602b36f177 | ||
![]() |
74a0fdc1a4 | ||
![]() |
493e98ec5e | ||
![]() |
646cdf4821 | ||
![]() |
a1ba6cf5ae | ||
![]() |
41b381a08b | ||
![]() |
3236b209b5 | ||
![]() |
2124926520 | ||
![]() |
ba9826e81c | ||
![]() |
7c4472dbcf | ||
![]() |
0db7fb9961 | ||
![]() |
aefcd1e623 | ||
![]() |
b7b9d6344b | ||
![]() |
7e61ea5847 | ||
![]() |
3a2c7247e1 | ||
![]() |
2a105263a5 | ||
![]() |
9facd4db8e | ||
![]() |
6c1466d327 | ||
![]() |
b26427e53e | ||
![]() |
086f5bd3b6 | ||
![]() |
bdb2a5ee76 | ||
![]() |
8e1abe543f | ||
![]() |
af6247d08a | ||
![]() |
f87c8a916e | ||
![]() |
d6790970e0 | ||
![]() |
fa62771e12 | ||
![]() |
935101478d | ||
![]() |
4abca36d2a | ||
![]() |
56013f801f | ||
![]() |
fb99aeb8e3 | ||
![]() |
b78eaea668 | ||
![]() |
83681c63a7 | ||
![]() |
6eb237a86d | ||
![]() |
b1febf84ed | ||
![]() |
2546768411 | ||
![]() |
8cdddb18c5 | ||
![]() |
4457a83971 | ||
![]() |
c8fc1974e1 | ||
![]() |
291e58ad85 | ||
![]() |
1790ca7f76 | ||
![]() |
9a1617cf46 | ||
![]() |
6fe65dc1af | ||
![]() |
91d3d73121 | ||
![]() |
7a5d08caa7 | ||
![]() |
e373fffa0a | ||
![]() |
bb24f595c2 | ||
![]() |
d44b8c5e53 | ||
![]() |
4b13327683 | ||
![]() |
49ba4cbc60 | ||
![]() |
9649109f2e | ||
![]() |
087311f996 | ||
![]() |
9979c3d928 | ||
![]() |
738fb9213f | ||
![]() |
8925cc44da | ||
![]() |
7574328996 |
2
.gitattributes
vendored
2
.gitattributes
vendored
|
@ -1,2 +1,2 @@
|
|||
* text=auto
|
||||
dist/index.js -text
|
||||
/dist/index.js binary
|
||||
|
|
14
.github/FUNDING.yml
vendored
14
.github/FUNDING.yml
vendored
|
@ -1,12 +1,2 @@
|
|||
# These are supported funding model platforms
|
||||
|
||||
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']
|
||||
custom:
|
||||
- https://opencollective.com/pnpm
|
||||
|
|
7
.github/dependabot.yml
vendored
Normal file
7
.github/dependabot.yml
vendored
Normal file
|
@ -0,0 +1,7 @@
|
|||
version: 2
|
||||
updates:
|
||||
- package-ecosystem: github-actions
|
||||
directory: "/"
|
||||
schedule:
|
||||
interval: weekly
|
||||
open-pull-requests-limit: 10
|
128
.github/workflows/test.yaml
vendored
128
.github/workflows/test.yaml
vendored
|
@ -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:
|
||||
name: Test with explicit inputs
|
||||
test_dest:
|
||||
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
|
||||
|
|
3
.gitignore
vendored
3
.gitignore
vendored
|
@ -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
|
||||
|
|
145
README.md
145
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:
|
||||
- uses: actions/checkout@v2
|
||||
|
||||
- uses: pnpm/action-setup@v1
|
||||
with:
|
||||
version: 4.11.1
|
||||
|
||||
- name: Install dependencies
|
||||
run: pnpm install
|
||||
steps:
|
||||
- uses: pnpm/action-setup@v4
|
||||
with:
|
||||
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
|
||||
|
||||
```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/)
|
||||
|
|
36
action.yml
36
action.yml
|
@ -1,24 +1,34 @@
|
|||
name: Setup PNPM
|
||||
description: Install PNPM package manager
|
||||
name: Setup pnpm
|
||||
description: Install pnpm package manager
|
||||
branding:
|
||||
icon: package
|
||||
color: orange
|
||||
inputs:
|
||||
version:
|
||||
description: Version of PNPM to install
|
||||
required: true
|
||||
description: Version of pnpm to install
|
||||
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)
|
||||
required: false
|
||||
default: ~/setup-pnpm/.bin
|
||||
registry:
|
||||
description: Registry to download PNPM from
|
||||
required: false
|
||||
default: https://registry.npmjs.com
|
||||
description: Location of `pnpm` and `pnpx` command
|
||||
runs:
|
||||
using: node12
|
||||
using: node20
|
||||
main: dist/index.js
|
||||
post: dist/index.js
|
||||
|
|
BIN
dist/index.js
vendored
BIN
dist/index.js
vendored
Binary file not shown.
220780
dist/pnpm.cjs
vendored
Normal file
220780
dist/pnpm.cjs
vendored
Normal file
File diff suppressed because one or more lines are too long
16625
dist/worker.js
vendored
Normal file
16625
dist/worker.js
vendored
Normal file
File diff suppressed because it is too large
Load Diff
19
package.json
19
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": {
|
||||
"download": "^8.0.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",
|
||||
"@types/download": "^6.2.4",
|
||||
"@types/expand-tilde": "^2.0.0",
|
||||
"@types/node": "^13.13.5"
|
||||
"yaml": "^2.3.4",
|
||||
"zod": "^3.22.4"
|
||||
},
|
||||
"devDependencies": {
|
||||
"typescript": "^3.8.3",
|
||||
"@zeit/ncc": "^0.22.1"
|
||||
"@vercel/ncc": "^0.38.1",
|
||||
"pnpm": "^8.14.3",
|
||||
"typescript": "^5.3.3"
|
||||
}
|
||||
}
|
||||
|
|
998
pnpm-lock.yaml
998
pnpm-lock.yaml
File diff suppressed because it is too large
Load Diff
|
@ -1,6 +1,10 @@
|
|||
{
|
||||
"$schema": "https://docs.renovatebot.com/renovate-schema.json",
|
||||
"pinVersions": false,
|
||||
"extends": [
|
||||
"config:base"
|
||||
],
|
||||
"ignoreDeps": [
|
||||
"ajv"
|
||||
]
|
||||
}
|
||||
|
|
4
run.sh
4
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_REGISTRY=https://registry.npmjs.com
|
||||
export INPUT_RUN_INSTALL=null
|
||||
export INPUT_standalone=false
|
||||
exec node dist/index.js
|
||||
|
|
17
src/index.ts
17
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(() => {
|
||||
console.log('Installation Completed!')
|
||||
setOutputs(inputs)
|
||||
})
|
||||
const isPost = getState('is_post')
|
||||
if (isPost === 'true') return pruneStore(inputs)
|
||||
saveState('is_post', 'true')
|
||||
await installPnpm(inputs)
|
||||
console.log('Installation Completed!')
|
||||
setOutputs(inputs)
|
||||
pnpmInstall(inputs)
|
||||
}
|
||||
|
||||
main().catch(error => {
|
||||
|
|
|
@ -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 registry: string
|
||||
readonly runInstall: RunInstall[]
|
||||
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'),
|
||||
registry: getInput('registry', options),
|
||||
runInstall: parseRunInstall('run_install'),
|
||||
packageJsonFile: parseInputPath('package_json_file'),
|
||||
standalone: getBooleanInput('standalone'),
|
||||
})
|
||||
|
||||
export default getInputs
|
||||
|
|
41
src/inputs/run-install.ts
Normal file
41
src/inputs/run-install.ts
Normal file
|
@ -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)
|
||||
}
|
||||
}
|
|
@ -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}`)
|
||||
}
|
||||
}
|
||||
|
104
src/install-pnpm/run.ts
Normal file
104
src/install-pnpm/run.ts
Normal file
|
@ -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
|
|
@ -1,25 +0,0 @@
|
|||
import { spawn } from 'child_process'
|
||||
import { execPath } from 'process'
|
||||
import { downloadSelfInstaller } from '../self-installer'
|
||||
import { Inputs } from '../inputs'
|
||||
|
||||
export 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'],
|
||||
})
|
||||
|
||||
downloadSelfInstaller().pipe(cp.stdin)
|
||||
|
||||
return new Promise((resolve, reject) => {
|
||||
cp.on('error', reject)
|
||||
cp.on('close', resolve)
|
||||
})
|
||||
}
|
||||
|
||||
export default runSelfInstaller
|
|
@ -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
|
||||
|
|
38
src/pnpm-install/index.ts
Normal file
38
src/pnpm-install/index.ts
Normal file
|
@ -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
|
31
src/pnpm-store-prune/index.ts
Normal file
31
src/pnpm-store-prune/index.ts
Normal file
|
@ -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
|
|
@ -1,4 +0,0 @@
|
|||
import download from 'download'
|
||||
import url from './url'
|
||||
export const downloadSelfInstaller = () => download(url)
|
||||
export default downloadSelfInstaller
|
|
@ -1,2 +0,0 @@
|
|||
export * from './url'
|
||||
export * from './download'
|
|
@ -1,3 +0,0 @@
|
|||
export const ref = '301414cec74a2b6b63c95b42f2ad1790ccb980ed'
|
||||
export const url = `https://raw.githubusercontent.com/pnpm/self-installer/${ref}/install.js`
|
||||
export default url
|
10
src/utils/index.ts
Normal file
10
src/utils/index.ts
Normal file
|
@ -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,
|
||||
})
|
|
@ -1,15 +1,11 @@
|
|||
|
||||
{
|
||||
"compilerOptions": {
|
||||
"target": "ES2018",
|
||||
"module": "CommonJS",
|
||||
"moduleResolution": "Node",
|
||||
"target": "ES2022",
|
||||
"module": "Node16",
|
||||
"resolveJsonModule": true,
|
||||
"lib": [
|
||||
"ES2018",
|
||||
"ES2019",
|
||||
"ES2020",
|
||||
"ESNext"
|
||||
"ES2023"
|
||||
],
|
||||
"outDir": "./dist/tsc",
|
||||
"preserveConstEnums": true,
|
||||
|
|
Loading…
Reference in New Issue
Block a user