Compare commits

...
18 Commits
Author SHA1 Message Date
Khải 0b715c7ebb Merge pull request #75 from ojeytonwilliams/fix/caching-example
docs: update the caching example
2023-07-25 17:00:41 +07:00
Khải 2ed49cbb02 Merge pull request #88 from KengoTODA/make-path-configurable
support projects that have package.json in non-root directory
2023-07-25 16:59:00 +07:00
Khải 218cb35941 Merge pull request #69 from zakuro9715/zakuro9715-patch-2
Remove corepack url in error message
2023-07-25 14:16:42 +07:00
Khải 3723f63bb4 Merge pull request #90 from pnpm/optional-version
feat: make version actually optional
2023-07-25 14:05:04 +07:00
khai96_ 849d884800 feat: make version actually optional
closes https://github.com/pnpm/action-setup/issues/85
2023-07-25 14:01:28 +07:00
khai96_ f92eb0edb6 docs: update pnpm version in readme
fixes https://github.com/pnpm/action-setup/issues/89
2023-07-25 13:50:35 +07:00
Kengo TODA b27f801bf9 feat: add package_json_file option
Signed-off-by: Kengo TODA <[email protected]>
2023-07-08 07:02:46 +08:00
Khải 11dd14d0c0 Change sponsor to pnpm's opencollective 2023-04-22 17:39:01 +07:00
Oliver Eyton-Williams 61eb8c655a docs: update the caching example 2023-03-08 00:13:47 +01:00
zakuro 65db188e28 Remove corepack url in error message 2022-11-09 06:54:12 +09:00
Khải 0609f0983b Merge pull request #66 from mrienstra/patch-1
docs: drop minor & patch version from examples
2022-11-02 12:09:43 +07:00
Michael Rienstra 7208fa2733 docs: drop minor & patch version from examples 2022-11-01 21:55:20 -07:00
Khải 1bd00a2972 Merge pull request #64 from mrienstra/patch-1
typo: not latest version
2022-10-26 10:32:07 +07:00
Michael Rienstra d5601fb603 bump first occurrence of actions/checkout to v3 2022-10-25 10:52:54 -07:00
Michael Rienstra bc06aa6030 typo: not latest version 2022-10-25 10:42:24 -07:00
Khải cd2af74528 Merge pull request #62 from melMass/mel/fix-readme
fix: ⚡️ cross-platform example
2022-10-18 17:29:18 +07:00
Mel Massadian c8a150e137 fix: ⚡️ just use shell:bash
set-output is deprecated see #58
2022-10-18 12:23:15 +02:00
Mel Massadian ed0172a253 fix: ⚡️ cross-platform example 2022-10-18 12:02:38 +02:00
6 changed files with 28 additions and 28 deletions

No files matched your search

+2 -12
View File
@@ -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
+13 -10
View File
@@ -38,6 +38,10 @@ If `run_install` is a YAML string representation of either an object or an array
**Optional** (_type:_ `string[]`) Additional arguments after `pnpm [recursive] install`, e.g. `[--frozen-lockfile, --strict-peer-dependencies]`.
### `package_json_file`
**Optional** File path to the `package.json` to read "packageManager" configutation. If not specified, `package.json` in the project root directory is used.
## Outputs
### `dest`
@@ -62,9 +66,9 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: pnpm/action-setup@v2.2.4
- uses: pnpm/action-setup@v2
with:
version: 6.0.2
version: 8
```
### Install pnpm and a few npm packages
@@ -79,11 +83,11 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v3
- uses: pnpm/action-setup@v2.2.4
- uses: pnpm/action-setup@v2
with:
version: 6.0.2
version: 8
run_install: |
- recursive: true
args: [--frozen-lockfile, --strict-peer-dependencies]
@@ -110,22 +114,21 @@ jobs:
with:
node-version: 16
- uses: pnpm/action-setup@v2.0.1
- uses: pnpm/action-setup@v2
name: Install pnpm
id: pnpm-install
with:
version: 7
run_install: false
- name: Get pnpm store directory
id: pnpm-cache
shell: bash
run: |
echo "STORE_PATH=$(pnpm store path)" >> $GITHUB_OUTPUT
echo "STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV
- uses: actions/cache@v3
name: Setup pnpm cache
with:
path: ${{ steps.pnpm-cache.outputs.STORE_PATH }}
path: ${{ env.STORE_PATH }}
key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
restore-keys: |
${{ runner.os }}-pnpm-store-
+5
View File
@@ -6,6 +6,7 @@ branding:
inputs:
version:
description: Version of pnpm to install
required: false
dest:
description: Where to store pnpm files
required: false
@@ -14,6 +15,10 @@ inputs:
description: If specified, run `pnpm install`
required: false
default: 'null'
package_json_file:
description: File path to the package.json to read "packageManager" configutation
required: false
default: 'package.json'
runs:
using: node16
main: dist/index.js
+1 -1
View File
@@ -1,4 +1,4 @@
(()=>{var e={9450:function(e,r,t){"use strict";var a=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(r,"__esModule",{value:true});const i=t(8829);const n=a(t(8436));const s=a(t(2191));const o=a(t(3326));const l=a(t(9150));const u=a(t(9268));async function main(){const e=(0,n.default)();const r=(0,i.getState)("is_post");if(r==="true")return(0,u.default)(e);(0,i.saveState)("is_post","true");await(0,s.default)(e);console.log("Installation Completed!");(0,o.default)(e);(0,l.default)(e)}main().catch((e=>{console.error(e);(0,i.setFailed)(e)}))},8436:function(e,r,t){"use strict";var a=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(r,"__esModule",{value:true});r.getInputs=void 0;const i=t(8829);const n=a(t(6906));const s=t(4264);const o={required:true};const parseInputPath=e=>(0,n.default)((0,i.getInput)(e,o));const getInputs=()=>({version:(0,i.getInput)("version"),dest:parseInputPath("dest"),runInstall:(0,s.parseRunInstall)("run_install")});r.getInputs=getInputs;r["default"]=r.getInputs},4264:function(e,r,t){"use strict";var a=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(r,"__esModule",{value:true});r.parseRunInstall=void 0;const i=t(8829);const n=a(t(4376));const s=t(1236);const o=a(t(7282));const l=a(t(5379));const u={required:true};function parseRunInstall(e){const r=(0,s.load)((0,i.getInput)(e,u));const t=new n.default({allErrors:true});const a=t.compile(l.default);if(!a(r)){for(const e of a.errors){(0,i.error)(`with.run_install${e.dataPath}: ${e.message}`)}return o.default.exit(1)}if(!r)return[];if(r===true)return[{recursive:true}];if(Array.isArray(r))return r;return[r]}r.parseRunInstall=parseRunInstall},2191:function(e,r,t){"use strict";var a=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(r,"__esModule",{value:true});r.install=r.runSelfInstaller=void 0;const i=t(8829);const n=a(t(5907));r.runSelfInstaller=n.default;async function install(e){(0,i.startGroup)("Running self-installer...");const r=await(0,n.default)(e);(0,i.endGroup)();if(r){return(0,i.setFailed)(`Something went wrong, self-installer exits with code ${r}`)}}r.install=install;r["default"]=install},5907:function(e,r,t){"use strict";var a=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(r,"__esModule",{value:true});r.runSelfInstaller=void 0;const i=t(8829);const n=t(2081);const s=t(1690);const o=a(t(1017));const l=t(7282);async function runSelfInstaller(e){const{version:r,dest:t}=e;await(0,s.remove)(t);const a=o.default.join(t,"package.json");await(0,s.ensureFile)(a);await(0,s.writeFile)(a,JSON.stringify({private:true}));const u=await readTarget(r);const c=(0,n.spawn)(l.execPath,[o.default.join(__dirname,"pnpm.js"),"install",u,"--no-lockfile"],{cwd:t,stdio:["pipe","inherit","inherit"]});const f=await new Promise(((e,r)=>{c.on("error",r);c.on("close",e)}));if(f===0){const e=o.default.join(t,"node_modules/.bin");(0,i.addPath)(e);(0,i.exportVariable)("PNPM_HOME",e)}return f}r.runSelfInstaller=runSelfInstaller;async function readTarget(e){if(e)return`pnpm@${e}`;const{GITHUB_WORKSPACE:r}=process.env;if(!r){throw new Error(`No workspace is found.\nIf you're intended to let pnpm/action-setup read preferred pnpm version from the "packageManager" field in the package.json file,\nplease run the actions/checkout before pnpm/action-setup.\nOtherwise, please specify the pnpm version in the action configuration.`)}const{packageManager:t}=JSON.parse(await(0,s.readFile)(o.default.join(r,"package.json"),"utf8"));if(typeof t!=="string"){throw new Error(`No pnpm version is specified.\nPlease specify it by one of the following ways:\n - in the GitHub Action config with the key "version"\n - in the package.json with the key "packageManager" (See https://nodejs.org/api/corepack.html)`)}if(!t.startsWith("pnpm@")){throw new Error("Invalid packageManager field in package.json")}return t}r["default"]=runSelfInstaller},3326:(e,r,t)=>{"use strict";Object.defineProperty(r,"__esModule",{value:true});r.setOutputs=void 0;const a=t(8829);const i=t(3763);function setOutputs(e){const r=(0,i.getBinDest)(e);(0,a.addPath)(r);(0,a.setOutput)("dest",e.dest);(0,a.setOutput)("bin_dest",r)}r.setOutputs=setOutputs;r["default"]=setOutputs},9150:(e,r,t)=>{"use strict";Object.defineProperty(r,"__esModule",{value:true});r.runPnpmInstall=void 0;const a=t(8829);const i=t(2081);const n=t(3763);function runPnpmInstall(e){const r=(0,n.patchPnpmEnv)(e);for(const t of e.runInstall){const e=["install"];if(t.recursive)e.unshift("recursive");if(t.args)e.push(...t.args);const n=["pnpm",...e].join(" ");(0,a.startGroup)(`Running ${n}...`);const{error:s,status:o}=(0,i.spawnSync)("pnpm",e,{stdio:"inherit",cwd:t.cwd,shell:true,env:r});(0,a.endGroup)();if(s){(0,a.setFailed)(s);continue}if(o){(0,a.setFailed)(`Command ${n} (cwd: ${t.cwd}) exits with st Line truncated
(()=>{var e={9450:function(e,r,t){"use strict";var a=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(r,"__esModule",{value:true});const i=t(8829);const n=a(t(8436));const s=a(t(2191));const o=a(t(3326));const l=a(t(9150));const u=a(t(9268));async function main(){const e=(0,n.default)();const r=(0,i.getState)("is_post");if(r==="true")return(0,u.default)(e);(0,i.saveState)("is_post","true");await(0,s.default)(e);console.log("Installation Completed!");(0,o.default)(e);(0,l.default)(e)}main().catch((e=>{console.error(e);(0,i.setFailed)(e)}))},8436:function(e,r,t){"use strict";var a=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(r,"__esModule",{value:true});r.getInputs=void 0;const i=t(8829);const n=a(t(6906));const s=t(4264);const o={required:true};const parseInputPath=e=>(0,n.default)((0,i.getInput)(e,o));const getInputs=()=>({version:(0,i.getInput)("version"),dest:parseInputPath("dest"),runInstall:(0,s.parseRunInstall)("run_install"),packageJsonFile:parseInputPath("package_json_file")});r.getInputs=getInputs;r["default"]=r.getInputs},4264:function(e,r,t){"use strict";var a=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(r,"__esModule",{value:true});r.parseRunInstall=void 0;const i=t(8829);const n=a(t(4376));const s=t(1236);const o=a(t(7282));const l=a(t(5379));const u={required:true};function parseRunInstall(e){const r=(0,s.load)((0,i.getInput)(e,u));const t=new n.default({allErrors:true});const a=t.compile(l.default);if(!a(r)){for(const e of a.errors){(0,i.error)(`with.run_install${e.dataPath}: ${e.message}`)}return o.default.exit(1)}if(!r)return[];if(r===true)return[{recursive:true}];if(Array.isArray(r))return r;return[r]}r.parseRunInstall=parseRunInstall},2191:function(e,r,t){"use strict";var a=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(r,"__esModule",{value:true});r.install=r.runSelfInstaller=void 0;const i=t(8829);const n=a(t(5907));r.runSelfInstaller=n.default;async function install(e){(0,i.startGroup)("Running self-installer...");const r=await(0,n.default)(e);(0,i.endGroup)();if(r){return(0,i.setFailed)(`Something went wrong, self-installer exits with code ${r}`)}}r.install=install;r["default"]=install},5907:function(e,r,t){"use strict";var a=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(r,"__esModule",{value:true});r.runSelfInstaller=void 0;const i=t(8829);const n=t(2081);const s=t(1690);const o=a(t(1017));const l=t(7282);async function runSelfInstaller(e){const{version:r,dest:t,packageJsonFile:a}=e;await(0,s.remove)(t);const u=o.default.join(t,"package.json");await(0,s.ensureFile)(u);await(0,s.writeFile)(u,JSON.stringify({private:true}));const c=await readTarget(a,r);const f=(0,n.spawn)(l.execPath,[o.default.join(__dirname,"pnpm.js"),"install",c,"--no-lockfile"],{cwd:t,stdio:["pipe","inherit","inherit"]});const p=await new Promise(((e,r)=>{f.on("error",r);f.on("close",e)}));if(p===0){const e=o.default.join(t,"node_modules/.bin");(0,i.addPath)(e);(0,i.exportVariable)("PNPM_HOME",e)}return p}r.runSelfInstaller=runSelfInstaller;async function readTarget(e,r){if(r)return`pnpm@${r}`;const{GITHUB_WORKSPACE:t}=process.env;if(!t){throw new Error(`No workspace is found.\nIf you're intended to let pnpm/action-setup read preferred pnpm version from the "packageManager" field in the package.json file,\nplease run the actions/checkout before pnpm/action-setup.\nOtherwise, please specify the pnpm version in the action configuration.`)}const{packageManager:a}=JSON.parse(await(0,s.readFile)(o.default.join(t,e),"utf8"));if(typeof a!=="string"){throw new Error(`No pnpm version is specified.\nPlease specify it by one of the following ways:\n - in the GitHub Action config with the key "version"\n - in the package.json with the key "packageManager" (See https://nodejs.org/api/corepack.html)`)}if(!a.startsWith("pnpm@")){throw new Error("Invalid packageManager field in package.json")}return a}r["default"]=runSelfInstaller},3326:(e,r,t)=>{"use strict";Object.defineProperty(r,"__esModule",{value:true});r.setOutputs=void 0;const a=t(8829);const i=t(3763);function setOutputs(e){const r=(0,i.getBinDest)(e);(0,a.addPath)(r);(0,a.setOutput)("dest",e.dest);(0,a.setOutput)("bin_dest",r)}r.setOutputs=setOutputs;r["default"]=setOutputs},9150:(e,r,t)=>{"use strict";Object.defineProperty(r,"__esModule",{value:true});r.runPnpmInstall=void 0;const a=t(8829);const i=t(2081);const n=t(3763);function runPnpmInstall(e){const r=(0,n.patchPnpmEnv)(e);for(const t of e.runInstall){const e=["install"];if(t.recursive)e.unshift("recursive");if(t.args)e.push(...t.args);const n=["pnpm",...e].join(" ");(0,a.startGroup)(`Running ${n}...`);const{error:s,status:o}=(0,i.spawnSync)("pnpm",e,{stdio:"inherit",cwd:t.cwd,shell:true,env:r});(0,a.endGroup)();if(s){(0,a.setFailed)(s);continue}if(oLine truncated
/*!
* expand-tilde <https://github.com/jonschlinkert/expand-tilde>
*
+2
View File
@@ -6,6 +6,7 @@ export interface Inputs {
readonly version?: string
readonly dest: string
readonly runInstall: RunInstall[]
readonly packageJsonFile: string
}
const options: InputOptions = {
@@ -18,6 +19,7 @@ export const getInputs = (): Inputs => ({
version: getInput('version'),
dest: parseInputPath('dest'),
runInstall: parseRunInstall('run_install'),
packageJsonFile: parseInputPath('package_json_file'),
})
export default getInputs
+5 -5
View File
@@ -6,7 +6,7 @@ import { execPath } from 'process'
import { Inputs } from '../inputs'
export async function runSelfInstaller(inputs: Inputs): Promise<number> {
const { version, dest } = inputs
const { version, dest, packageJsonFile } = inputs
// prepare self install
await remove(dest)
@@ -15,7 +15,7 @@ export async function runSelfInstaller(inputs: Inputs): Promise<number> {
await writeFile(pkgJson, JSON.stringify({ private: true }))
// prepare target pnpm
const target = await readTarget(version)
const target = await readTarget(packageJsonFile, version)
const cp = spawn(execPath, [path.join(__dirname, 'pnpm.js'), 'install', target, '--no-lockfile'], {
cwd: dest,
stdio: ['pipe', 'inherit', 'inherit'],
@@ -33,7 +33,7 @@ export async function runSelfInstaller(inputs: Inputs): Promise<number> {
return exitCode
}
async function readTarget(version?: string | undefined) {
async function readTarget(packageJsonFile: string, version?: string | undefined) {
if (version) return `pnpm@${version}`
const { GITHUB_WORKSPACE } = process.env
@@ -44,12 +44,12 @@ please run the actions/checkout before pnpm/action-setup.
Otherwise, please specify the pnpm version in the action configuration.`)
}
const { packageManager } = JSON.parse(await readFile(path.join(GITHUB_WORKSPACE, 'package.json'), 'utf8'))
const { packageManager } = JSON.parse(await readFile(path.join(GITHUB_WORKSPACE, packageJsonFile), 'utf8'))
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" (See https://nodejs.org/api/corepack.html)`)
- in the package.json with the key "packageManager"`)
}
if (!packageManager.startsWith('pnpm@')) {