Skip to content

Commit 86bf502

Browse files
authored
extend documentation on scope parameter (#470)
This also ends all descriptions with a full stop (`.`).
1 parent 146c4d8 commit 86bf502

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

Diff for: action.yml

+9-9
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,35 @@
11
name: 'Setup Node.js environment'
2-
description: 'Setup a Node.js environment by adding problem matchers and optionally downloading and adding it to the PATH'
2+
description: 'Setup a Node.js environment by adding problem matchers and optionally downloading and adding it to the PATH.'
33
author: 'GitHub'
44
inputs:
55
always-auth:
6-
description: 'Set always-auth in npmrc'
6+
description: 'Set always-auth in npmrc.'
77
default: 'false'
88
node-version:
9-
description: 'Version Spec of the version to use. Examples: 12.x, 10.15.1, >=10.15.0'
9+
description: 'Version Spec of the version to use. Examples: 12.x, 10.15.1, >=10.15.0.'
1010
node-version-file:
11-
description: 'File containing the version Spec of the version to use. Examples: .nvmrc, .node-version'
11+
description: 'File containing the version Spec of the version to use. Examples: .nvmrc, .node-version.'
1212
architecture:
1313
description: 'Target architecture for Node to use. Examples: x86, x64. Will use system architecture by default.'
1414
check-latest:
15-
description: 'Set this option if you want the action to check for the latest available version that satisfies the version spec'
15+
description: 'Set this option if you want the action to check for the latest available version that satisfies the version spec.'
1616
default: false
1717
registry-url:
18-
description: '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'
18+
description: '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.'
1919
scope:
20-
description: 'Optional scope for authenticating against scoped registries'
20+
description: '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/).'
2121
token:
2222
description: Used to pull node distributions from node-versions. Since there's a default, this is typically not supplied by the user.
2323
default: ${{ github.token }}
2424
cache:
25-
description: 'Used to specify a package manager for caching in the default directory. Supported values: npm, yarn, pnpm'
25+
description: 'Used to specify a package manager for caching in the default directory. Supported values: npm, yarn, pnpm.'
2626
cache-dependency-path:
2727
description: '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.'
2828
# TODO: add input to control forcing to pull from cloud or dist.
2929
# escape valve for someone having issues or needing the absolute latest which isn't cached yet
3030
outputs:
3131
cache-hit:
32-
description: 'A boolean value to indicate if a cache was hit'
32+
description: 'A boolean value to indicate if a cache was hit.'
3333
runs:
3434
using: 'node16'
3535
main: 'dist/setup/index.js'

0 commit comments

Comments
 (0)