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
Right now the documentation of valid inputs (and outputs) seems to be
manually maintained inside the `README.md` with a reference to the
`actions.yml` file.
Since this can be rather tedious to maintain this commit now uses
[github-actions-docs][1] to automatically generate documentation.
[1]: https://www.npmjs.com/package/github-action-docs
# File containing the version Spec of the version to use. Examples: package.json, .nvmrc, .node-version, .tool-versions.
29
-
# If node-version and node-version-file are both provided the action will use version from node-version.
30
-
node-version-file: ''
31
-
32
-
# Set this option if you want the action to check for the latest available version
33
-
# that satisfies the version spec.
34
-
# It will only get affect for lts Nodejs versions (12.x, >=10.15.0, lts/Hydrogen).
35
-
# Default: false
36
-
check-latest: false
37
-
38
-
# Target architecture for Node to use. Examples: x86, x64. Will use system architecture by default.
39
-
# Default: ''. The action use system architecture by default
40
-
architecture: ''
41
-
42
-
# Used to pull node distributions from https://github.com/actions/node-versions.
43
-
# Since there's a default, this is typically not supplied by the user.
44
-
# When running this action on github.com, the default value is sufficient.
45
-
# When running on GHES, you can pass a personal access token for github.com if you are experiencing rate limiting.
46
-
#
47
-
# We recommend using a service account with the least permissions necessary. Also
48
-
# when generating a new PAT, select the least scopes necessary.
49
-
#
50
-
# [Learn more about creating and using encrypted secrets](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets)
# Used to specify a package manager for caching in the default directory. Supported values: npm, yarn, pnpm.
56
-
# Package manager should be pre-installed
57
-
# Default: ''
58
-
cache: ''
59
-
60
-
# Used to specify the path to a dependency file: package-lock.json, yarn.lock, etc.
61
-
# It will generate hash from the target file for primary key. It works only If cache is specified.
62
-
# Supports wildcards or a list of file names for caching multiple dependencies.
63
-
# Default: ''
64
-
cache-dependency-path: ''
65
-
66
-
# Optional registry to set up for auth. Will set the registry in a project level .npmrc and .yarnrc file,
67
-
# and set up auth to read in from env.NODE_AUTH_TOKEN.
68
-
# Default: ''
69
-
registry-url: ''
70
-
71
-
# Optional scope for authenticating against scoped registries.
72
-
# Will fall back to the repository owner when using the GitHub Packages registry (https://npm.pkg.github.com/).
73
-
# Default: ''
74
-
scope: ''
75
-
76
-
# Set always-auth option in npmrc file.
77
-
# Default: ''
78
-
always-auth: ''
79
-
```
80
-
<!-- end usage -->
19
+
<!-- markdownlint-capture -->
20
+
<!-- markdownlint-disable -->
21
+
<!-- prettier-ignore-start -->
22
+
<!-- BEGIN_GITHUB_ACTION_DOCS -->
23
+
## Inputs
24
+
25
+
| Name | Description | Default | Required |
26
+
|------|-------------|---------|:--------:|
27
+
| <aname="input_always_auth"></a> [always-auth](#input\_always\_auth)| Set always-auth in npmrc. |`false`| no |
28
+
| <aname="input_architecture"></a> [architecture](#input\_architecture)| Target architecture for Node to use. Examples: x86, x64. Will use system architecture by default. || no |
29
+
| <aname="input_cache"></a> [cache](#input\_cache)| Used to specify a package manager for caching in the default directory. Supported values: npm, yarn, pnpm. || no |
30
+
| <aname="input_cache_dependency_path"></a> [cache-dependency-path](#input\_cache\_dependency\_path)| Used to specify the path to a dependency file: package-lock.json, yarn.lock, etc. Supports wildcards or a list of file names for caching multiple dependencies. || no |
31
+
| <aname="input_check_latest"></a> [check-latest](#input\_check\_latest)| Set this option if you want the action to check for the latest available version that satisfies the version spec. || no |
32
+
| <aname="input_node_version"></a> [node-version](#input\_node\_version)| Version Spec of the version to use. Examples: 12.x, 10.15.1, >=10.15.0. || no |
33
+
| <aname="input_node_version_file"></a> [node-version-file](#input\_node\_version\_file)| File containing the version Spec of the version to use. Examples: package.json, .nvmrc, .node-version, .tool-versions. || no |
34
+
| <aname="input_registry_url"></a> [registry-url](#input\_registry\_url)| Optional registry to set up for auth. Will set the registry in a project level .npmrc and .yarnrc file, and set up auth to read in from env.NODE_AUTH_TOKEN. || no |
35
+
| <aname="input_scope"></a> [scope](#input\_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/).|| no |
36
+
| <aname="input_token"></a> [token](#input\_token)| Used to pull node distributions from node-versions. Since there's a default, this is typically not supplied by the user. When running this action on github.com, the default value is sufficient. When running on GHES, you can pass a personal access token for github.com if you are experiencing rate limiting. | `${{ github.server_url == 'https://github.com' && github.token || '' }}` | no |
37
+
38
+
## Outputs
39
+
40
+
| Name | Description |
41
+
|------|-------------|
42
+
| <aname="output_cache_hit"></a> [cache-hit](#output\_cache\_hit)| A boolean value to indicate if a cache was hit. |
43
+
| <aname="output_node_version"></a> [node-version](#output\_node\_version)| The installed node version. |
0 commit comments