Merge pull request #75 from ojeytonwilliams/fix/caching-example

docs: update the caching example

.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
-
-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

.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:
@@ -21,7 +22,7 @@ jobs:
           - windows-latest
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
       - name: Run the action
         uses: ./
@@ -50,18 +51,72 @@ jobs:
           - windows-latest
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
       - name: Run the action
         uses: ./
         with:
           version: 4.11.1
           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_run_install:
+    name: 'Test with run_install (${{ matrix.run_install.name }}, ${{ matrix.os }})'
+
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      fail-fast: false
+      matrix:
+        pnpm:
+          - 4.11.1
+        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
+                - pnpm
+          - name: 'array'
+            value: |
+              - {}
+              - recursive: true
+              - args:
+                - --global
+                - --global-dir=./pnpm-global
+                - npm
+                - yarn
+                - pnpm
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Run the action
+        uses: ./
+        with:
+          version: 4.11.1
+          run_install: ${{ matrix.run_install.value }}
+
+      - name: 'Test: which'
+        run: which pnpm; which pnpx
+
+      - name: 'Test: install'
+        run: pnpm install

.gitignore

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

README.md

@@ -1,24 +1,46 @@
-# Setup PNPM
+# Setup pnpm
 
-Install PNPM package manager.
+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** File path to the `package.json` to read "packageManager" configutation. If not specified, `package.json` in the project root directory is used.
 
 ## Outputs
 
@@ -28,29 +50,95 @@ Expanded path of inputs#dest.
 
 ### `bin_dest`
 
-Expanded path of inputs@bin_dest.
+Location of `pnpm` and `pnpx` command.
 
 ## Usage example
 
+### Just install pnpm
+
 ```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.1.0
-      with:
-        version: 4.11.1
-
-    - name: Install dependencies
-      run: pnpm install
+    steps:
+      - uses: pnpm/action-setup@v2
+        with:
+          version: 8
 ```
 
+### Install pnpm and a few npm packages
+
+```yaml
+on:
+  - push
+  - pull_request
+
+jobs:
+  install:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: pnpm/action-setup@v2
+        with:
+          version: 8
+          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@v3
+
+      - name: Install Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16
+
+      - uses: pnpm/action-setup@v2
+        name: Install pnpm
+        with:
+          version: 7
+          run_install: false
+
+      - name: Get pnpm store directory
+        shell: bash
+        run: |
+          echo "STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV
+
+      - uses: actions/cache@v3
+        name: Setup pnpm cache
+        with:
+          path: ${{ env.STORE_PATH }}
+          key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
+          restore-keys: |
+            ${{ runner.os }}-pnpm-store-
+
+      - 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.

action.yml

@@ -1,24 +1,25 @@
-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
-  bin_dest:
-    description: Where to store executables (pnpm and pnpx commands)
+  run_install:
+    description: If specified, run `pnpm install`
     required: false
-    default: ~/setup-pnpm/.bin
-  registry:
-    description: Registry to download PNPM from
+    default: 'null'
+  package_json_file:
+    description: File path to the package.json to read "packageManager" configutation
     required: false
-    default: https://registry.npmjs.com
+    default: 'package.json'
 runs:
-  using: node12
+  using: node16
   main: dist/index.js
+  post: dist/index.js

package.json

@@ -1,20 +1,26 @@
 {
   "private": true,
   "scripts": {
+    "build:schemas": "ts-schema-autogen generate",
     "build:ncc": "ncc build --minify --no-source-map-register --no-cache dist/tsc/index.js --out dist/",
-    "build": "tsc && pnpm run build:ncc",
+    "build": "pnpm run build:schemas && tsc && pnpm run build:ncc && cp src/install-pnpm/pnpm.js dist/pnpm.js",
     "start": "pnpm run build && sh ./run.sh"
   },
   "dependencies": {
-    "download": "^8.0.0",
-    "expand-tilde": "^2.0.2",
-    "@actions/core": "^1.2.4",
-    "@types/download": "^6.2.4",
+    "@actions/core": "^1.10.0",
     "@types/expand-tilde": "^2.0.0",
-    "@types/node": "^13.13.5"
+    "@types/fs-extra": "^9.0.13",
+    "@types/js-yaml": "^4.0.5",
+    "@types/node": "^14.18.32",
+    "@types/node-fetch": "^2.6.2",
+    "ajv": "^6.12.6",
+    "expand-tilde": "^2.0.2",
+    "fs-extra": "^10.1.0",
+    "js-yaml": "^4.1.0"
   },
   "devDependencies": {
-    "typescript": "^3.8.3",
-    "@zeit/ncc": "^0.22.1"
+    "@ts-schema-autogen/cli": "^0.1.2",
+    "@vercel/ncc": "^0.33.4",
+    "typescript": "^4.8.4"
   }
 }

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,5 @@
 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
 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(() => {
-    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 => {

src/inputs/index.ts

@@ -1,11 +1,12 @@
 import { 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
 }
 
 const options: InputOptions = {
@@ -15,10 +16,10 @@ 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'),
 })
 
 export default getInputs

src/inputs/run-install-input.schema.autogen.json

@@ -0,0 +1,21 @@
+{
+  "$schema": "https://raw.githubusercontent.com/ksxnodeapps/ts-schema-autogen/master/packages/schemas/config.schema.json",
+  "instruction": {
+    "compilerOptions": {
+      "strict": true,
+      "target": "ES2018",
+      "lib": [
+        "ES2018",
+        "ES2019",
+        "ES2020",
+        "ESNext"
+      ],
+      "moduleResolution": "Node",
+      "esModuleInterop": true,
+      "resolveJsonModule": true
+    },
+    "input": "run-install.ts",
+    "symbol": "RunInstallInput",
+    "output": "run-install-input.schema.json"
+  }
+}

src/inputs/run-install-input.schema.json

@@ -0,0 +1,39 @@
+{
+  "anyOf": [
+    {
+      "$ref": "#/definitions/RunInstall"
+    },
+    {
+      "type": "array",
+      "items": {
+        "$ref": "#/definitions/RunInstall"
+      }
+    },
+    {
+      "type": [
+        "null",
+        "boolean"
+      ]
+    }
+  ],
+  "definitions": {
+    "RunInstall": {
+      "type": "object",
+      "properties": {
+        "recursive": {
+          "type": "boolean"
+        },
+        "cwd": {
+          "type": "string"
+        },
+        "args": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        }
+      }
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

src/inputs/run-install.ts

@@ -0,0 +1,39 @@
+import { getInput, error, InputOptions } from '@actions/core'
+import Ajv from 'ajv'
+import { load } from 'js-yaml'
+import process from 'process'
+import runInstallSchema from './run-install-input.schema.json'
+
+export interface RunInstall {
+  readonly recursive?: boolean
+  readonly cwd?: string
+  readonly args?: readonly string[]
+}
+
+export type RunInstallInput =
+  | null
+  | boolean
+  | RunInstall
+  | RunInstall[]
+
+const options: InputOptions = {
+  required: true,
+}
+
+export function parseRunInstall(name: string): RunInstall[] {
+  const result: RunInstallInput = load(getInput(name, options)) as any
+  const ajv = new Ajv({
+    allErrors: true,
+  })
+  const validate = ajv.compile(runInstallSchema)
+  if (!validate(result)) {
+    for (const errorItem of validate.errors!) {
+      error(`with.run_install${errorItem.dataPath}: ${errorItem.message}`)
+    }
+    return process.exit(1)
+  }
+  if (!result) return []
+  if (result === true) return [{ recursive: true }]
+  if (Array.isArray(result)) return result
+  return [result]
+}

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,61 @@
+import { addPath, exportVariable } from '@actions/core'
+import { spawn } from 'child_process'
+import { remove, ensureFile, writeFile, readFile } from 'fs-extra'
+import path from 'path'
+import { execPath } from 'process'
+import { Inputs } from '../inputs'
+
+export async function runSelfInstaller(inputs: Inputs): Promise<number> {
+  const { version, dest, packageJsonFile } = inputs
+
+  // prepare self install
+  await remove(dest)
+  const pkgJson = path.join(dest, 'package.json')
+  await ensureFile(pkgJson)
+  await writeFile(pkgJson, JSON.stringify({ private: true }))
+
+  // prepare target pnpm
+  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'],
+  })
+
+  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(packageJsonFile: string, version?: string | undefined) {
+  if (version) return `pnpm@${version}`
+
+  const { GITHUB_WORKSPACE } = process.env
+  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,
+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, 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"`)
+  }
+
+  if (!packageManager.startsWith('pnpm@')) {
+    throw new Error('Invalid packageManager field in package.json')
+  }
+  return packageManager
+}
+
+export default runSelfInstaller

src/install/run.ts

@@ -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

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 download from 'download'
-import url from './url'
-export const downloadSelfInstaller = () => download(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,
+})