You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+13-13Lines changed: 13 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,22 +9,22 @@ This action installs [volta](https://volta.sh) by:
9
9
- downloading and caching volta (adding it to your $PATH)
10
10
- optionally downloading and caching a version of node - npm by version spec and add to PATH
11
11
12
-
<!-- action-docs-inputs -->
12
+
<!-- action-docs-inputs action="action.yml" -->
13
13
## Inputs
14
14
15
-
|parameter| description | required | default |
15
+
|name| description | required | default |
16
16
| --- | --- | --- | --- |
17
-
| volta-version | Version of `volta` to fetch and setup. Examples: 0.6.0, 10.15.1, >=10.15.0 |`false`||
18
-
| node-version | Version Spec of the node version to use. Examples: 10.6.x, 10.15.1, >=10.15.0 |`false`||
19
-
| npm-version | Version Spec of the npm version to use. Examples: 7.5.x, 7.5.3, >=7.5.3 |`false`||
20
-
| yarn-version | Version Spec of the yarn version to use. Examples: 1.6.x, 10.15.1, >=10.15.0 |`false`||
21
-
| 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`||
22
-
| 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`||
23
-
| 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`||
24
-
| 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`||
25
-
| 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 }} |
26
-
| always-auth | Set always-auth in npmrc |`false`| false |
27
-
<!-- action-docs-inputs -->
17
+
|`volta-version`|<p>Version of <code>volta</code> to fetch and setup. Examples: 0.6.0, 10.15.1, >=10.15.0</p>|`false`|`""`|
18
+
|`node-version`|<p>Version Spec of the node version to use. Examples: 10.6.x, 10.15.1, >=10.15.0</p>|`false`|`""`|
19
+
|`npm-version`|<p>Version Spec of the npm version to use. Examples: 7.5.x, 7.5.3, >=7.5.3</p>|`false`|`""`|
20
+
|`yarn-version`|<p>Version Spec of the yarn version to use. Examples: 1.6.x, 10.15.1, >=10.15.0</p>|`false`|`""`|
21
+
|`package-json-path`|<p>The path to the package.json to update when using an explicit <code>node-version</code>|<code>yarn-version</code>|<code>npm-version</code> override. By default, we will use <code>package.json</code> in the checkout root.</p>|`false`|`""`|
22
+
|`variant`|<p>Specific variant to install. Example: providing the variant "linux-openssl-rhel", which will target installing the volta-${version}-linux-openssl-rhel.tar.gz tarball</p>|`false`|`""`|
23
+
|`registry-url`|<p>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<em>AUTH</em>TOKEN</p>|`false`|`""`|
24
+
|`scope`|<p>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/).</p>|`false`|`""`|
25
+
|`token`|<p>Used to avoid low rate limiting for cached tool downloads. Since there's a default, this is typically not supplied by the user.</p>|`false`|`${{ github.token }}`|
26
+
|`always-auth`|<p>Set always-auth in npmrc</p>|`false`|`false`|
0 commit comments