diff --git a/README.md b/README.md index d37b5e17..46d19404 100644 --- a/README.md +++ b/README.md @@ -9,22 +9,22 @@ This action installs [volta](https://volta.sh) by: - downloading and caching volta (adding it to your $PATH) - optionally downloading and caching a version of node - npm by version spec and add to PATH - + ## Inputs -| parameter | description | required | default | +| name | description | required | default | | --- | --- | --- | --- | -| volta-version | Version of `volta` to fetch and setup. Examples: 0.6.0, 10.15.1, >=10.15.0 | `false` | | -| node-version | Version Spec of the node version to use. Examples: 10.6.x, 10.15.1, >=10.15.0 | `false` | | -| npm-version | Version Spec of the npm version to use. Examples: 7.5.x, 7.5.3, >=7.5.3 | `false` | | -| yarn-version | Version Spec of the yarn version to use. Examples: 1.6.x, 10.15.1, >=10.15.0 | `false` | | -| package-json-path | The path to the package.json to update when using an explicit `node-version` | `yarn-version` | `npm-version` override. By default, we will use `package.json` in the checkout root. | `false` | | -| variant | Specific variant to install. Example: providing the variant "linux-openssl-rhel", which will target installing the volta-${version}-linux-openssl-rhel.tar.gz tarball | `false` | | -| registry-url | Optional registry to set up for auth. Will set the registry in a project level .npmrc file, and set up auth to read in from env.NODE_AUTH_TOKEN | `false` | | -| scope | Optional scope for authenticating against scoped registries. Will fall back to the repository owner when using the GitHub Packages registry (https://npm.pkg.github.com/). | `false` | | -| token | Used to avoid low rate limiting for cached tool downloads. Since there's a default, this is typically not supplied by the user. | `false` | ${{ github.token }} | -| always-auth | Set always-auth in npmrc | `false` | false | - +| `volta-version` |

Version of volta to fetch and setup. Examples: 0.6.0, 10.15.1, >=10.15.0

| `false` | `""` | +| `node-version` |

Version Spec of the node version to use. Examples: 10.6.x, 10.15.1, >=10.15.0

| `false` | `""` | +| `npm-version` |

Version Spec of the npm version to use. Examples: 7.5.x, 7.5.3, >=7.5.3

| `false` | `""` | +| `yarn-version` |

Version Spec of the yarn version to use. Examples: 1.6.x, 10.15.1, >=10.15.0

| `false` | `""` | +| `package-json-path` |

The path to the package.json to update when using an explicit node-version | yarn-version | npm-version override. By default, we will use package.json in the checkout root.

| `false` | `""` | +| `variant` |

Specific variant to install. Example: providing the variant "linux-openssl-rhel", which will target installing the volta-${version}-linux-openssl-rhel.tar.gz tarball

| `false` | `""` | +| `registry-url` |

Optional registry to set up for auth. Will set the registry in a project level .npmrc file, and set up auth to read in from env.NODEAUTHTOKEN

| `false` | `""` | +| `scope` |

Optional scope for authenticating against scoped registries. Will fall back to the repository owner when using the GitHub Packages registry (https://npm.pkg.github.com/).

| `false` | `""` | +| `token` |

Used to avoid low rate limiting for cached tool downloads. Since there's a default, this is typically not supplied by the user.

| `false` | `${{ github.token }}` | +| `always-auth` |

Set always-auth in npmrc

| `false` | `false` | + ## Usage diff --git a/package-lock.json b/package-lock.json index 193ab526..6f527f72 100644 --- a/package-lock.json +++ b/package-lock.json @@ -25,7 +25,7 @@ "@typescript-eslint/eslint-plugin": "^8.0.1", "@typescript-eslint/parser": "^8.0.1", "@vercel/ncc": "^0.36.1", - "action-docs": "^1.2.0", + "action-docs": "^2.4.2", "broccoli-test-helper": "^2.0.0", "eslint": "^9.8.0", "eslint-config-prettier": "^9.1.0", @@ -1331,21 +1331,34 @@ } }, "node_modules/action-docs": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/action-docs/-/action-docs-1.2.0.tgz", - "integrity": "sha512-qSyslpGvLfrUSmYqFthlCcSbUCkDe4sr4Q3/imnUFwaH5gdD94WO+bjY4AfYJB2iBf+iNs0JYHU8UpCpnjSodg==", + "version": "2.4.2", + "resolved": "https://registry.npmjs.org/action-docs/-/action-docs-2.4.2.tgz", + "integrity": "sha512-p2dMdU/8EZ4vNmGvYPjndzDCzQ50jUY4qeOhM9T8Uhh1UYLWKCXHGesVTwMz7i5HcvFARhB5QzGOooVXHUnqUw==", "dev": true, "dependencies": { - "chalk": "^4.1.0", - "figlet": "^1.5.0", - "js-yaml": "^4.0.0", - "replace-in-file": "^6.3.5", - "yargs": "^17.6.0" + "chalk": "^5.3.0", + "figlet": "^1.7.0", + "replace-in-file": "^7.1.0", + "showdown": "^2.1.0", + "yaml": "^2.3.4", + "yargs": "^17.7.2" }, "bin": { "action-docs": "lib/cli.js" } }, + "node_modules/action-docs/node_modules/chalk": { + "version": "5.3.0", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-5.3.0.tgz", + "integrity": "sha512-dLitG79d+GV1Nb/VYcCDFivJeK1hiukt9QjRNVOsUtTy1rR1YJsmpGGTZ3qJos+uw7WmWF4wUwBd9jxjocFC2w==", + "dev": true, + "engines": { + "node": "^12.17.0 || ^14.13 || >=16.0.0" + }, + "funding": { + "url": "https://github.com/chalk/chalk?sponsor=1" + } + }, "node_modules/agent-base": { "version": "6.0.2", "resolved": "https://registry.npmjs.org/agent-base/-/agent-base-6.0.2.tgz", @@ -3945,9 +3958,9 @@ } }, "node_modules/figlet": { - "version": "1.6.0", - "resolved": "https://registry.npmjs.org/figlet/-/figlet-1.6.0.tgz", - "integrity": "sha512-31EQGhCEITv6+hi2ORRPyn3bulaV9Fl4xOdR169cBzH/n1UqcxsiSB/noo6SJdD7Kfb1Ljit+IgR1USvF/XbdA==", + "version": "1.7.0", + "resolved": "https://registry.npmjs.org/figlet/-/figlet-1.7.0.tgz", + "integrity": "sha512-gO8l3wvqo0V7wEFLXPbkX83b7MVjRrk1oRLfYlZXol8nEpb/ON9pcKLI4qpBv5YtOTfrINtqb7b40iYY2FTWFg==", "dev": true, "bin": { "figlet": "bin/index.js" @@ -8884,14 +8897,14 @@ } }, "node_modules/replace-in-file": { - "version": "6.3.5", - "resolved": "https://registry.npmjs.org/replace-in-file/-/replace-in-file-6.3.5.tgz", - "integrity": "sha512-arB9d3ENdKva2fxRnSjwBEXfK1npgyci7ZZuwysgAp7ORjHSyxz6oqIjTEv8R0Ydl4Ll7uOAZXL4vbkhGIizCg==", + "version": "7.2.0", + "resolved": "https://registry.npmjs.org/replace-in-file/-/replace-in-file-7.2.0.tgz", + "integrity": "sha512-CiLXVop3o8/h2Kd1PwKPPimmS9wUV0Ki6Fl8+1ITD35nB3Gl/PrW5IONpTE0AXk0z4v8WYcpEpdeZqMXvSnWpg==", "dev": true, "dependencies": { "chalk": "^4.1.2", - "glob": "^7.2.0", - "yargs": "^17.2.1" + "glob": "^8.1.0", + "yargs": "^17.7.2" }, "bin": { "replace-in-file": "bin/cli.js" @@ -8900,6 +8913,47 @@ "node": ">=10" } }, + "node_modules/replace-in-file/node_modules/brace-expansion": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.1.tgz", + "integrity": "sha512-XnAIvQ8eM+kC6aULx6wuQiwVsnzsi9d3WxzV3FpWTGA19F621kwdbsAcFKXgKUHZWsy+mY6iL1sHTxWEFCytDA==", + "dev": true, + "dependencies": { + "balanced-match": "^1.0.0" + } + }, + "node_modules/replace-in-file/node_modules/glob": { + "version": "8.1.0", + "resolved": "https://registry.npmjs.org/glob/-/glob-8.1.0.tgz", + "integrity": "sha512-r8hpEjiQEYlF2QU0df3dS+nxxSIreXQS1qRhMJM0Q5NDdR386C7jb7Hwwod8Fgiuex+k0GFjgft18yvxm5XoCQ==", + "deprecated": "Glob versions prior to v9 are no longer supported", + "dev": true, + "dependencies": { + "fs.realpath": "^1.0.0", + "inflight": "^1.0.4", + "inherits": "2", + "minimatch": "^5.0.1", + "once": "^1.3.0" + }, + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, + "node_modules/replace-in-file/node_modules/minimatch": { + "version": "5.1.6", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-5.1.6.tgz", + "integrity": "sha512-lKwV/1brpG6mBUFHtb7NUmtABCb2WZZmm2wNiOA5hAb8VdCS4B3dtMWyvcoViccwAW/COERjXLt0zP1zXUN26g==", + "dev": true, + "dependencies": { + "brace-expansion": "^2.0.1" + }, + "engines": { + "node": ">=10" + } + }, "node_modules/require-directory": { "version": "2.1.1", "resolved": "https://registry.npmjs.org/require-directory/-/require-directory-2.1.1.tgz", @@ -9556,6 +9610,31 @@ "node": ">=4" } }, + "node_modules/showdown": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/showdown/-/showdown-2.1.0.tgz", + "integrity": "sha512-/6NVYu4U819R2pUIk79n67SYgJHWCce0a5xTP979WbNp0FL9MN1I1QK662IDU1b6JzKTvmhgI7T7JYIxBi3kMQ==", + "dev": true, + "dependencies": { + "commander": "^9.0.0" + }, + "bin": { + "showdown": "bin/showdown.js" + }, + "funding": { + "type": "individual", + "url": "https://www.paypal.me/tiviesantos" + } + }, + "node_modules/showdown/node_modules/commander": { + "version": "9.5.0", + "resolved": "https://registry.npmjs.org/commander/-/commander-9.5.0.tgz", + "integrity": "sha512-KRs7WVDKg86PWiuAqhDrAQnTXZKraVcCc6vFdL14qrZ/DcWwuRo7VoiYXalXO7S5GKpqYiVEwCbgFDfxNHKJBQ==", + "dev": true, + "engines": { + "node": "^12.20.0 || >=14" + } + }, "node_modules/side-channel": { "version": "1.0.4", "resolved": "https://registry.npmjs.org/side-channel/-/side-channel-1.0.4.tgz", @@ -11498,6 +11577,18 @@ "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==", "dev": true }, + "node_modules/yaml": { + "version": "2.5.0", + "resolved": "https://registry.npmjs.org/yaml/-/yaml-2.5.0.tgz", + "integrity": "sha512-2wWLbGbYDiSqqIKoPjar3MPgB94ErzCtrNE1FdqGuaO0pi2JGjmE8aW8TDZwzU7vuxcGRdL/4gPQwQ7hD5AMSw==", + "dev": true, + "bin": { + "yaml": "bin.mjs" + }, + "engines": { + "node": ">= 14" + } + }, "node_modules/yargs": { "version": "17.7.2", "resolved": "https://registry.npmjs.org/yargs/-/yargs-17.7.2.tgz", diff --git a/package.json b/package.json index 4683643b..4073987e 100644 --- a/package.json +++ b/package.json @@ -44,7 +44,7 @@ "@typescript-eslint/eslint-plugin": "^8.0.1", "@typescript-eslint/parser": "^8.0.1", "@vercel/ncc": "^0.36.1", - "action-docs": "^1.2.0", + "action-docs": "^2.4.2", "broccoli-test-helper": "^2.0.0", "eslint": "^9.8.0", "eslint-config-prettier": "^9.1.0",