Skip to content

Commit 21ddc7b

Browse files
authored
Correct mirror option typos (#1442)
1 parent 65d868f commit 21ddc7b

File tree

2 files changed

+16
-16
lines changed

2 files changed

+16
-16
lines changed

README.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@ This action provides the following functionality for GitHub Actions users:
1616

1717
- Caching is now automatically enabled for npm projects when either the `devEngines.packageManager` field or the top-level `packageManager` field in `package.json` is set to `npm`. For other package managers, such as Yarn and pnpm, caching is disabled by default and must be configured manually using the `cache` input.
1818

19-
- The `always-auth` input has been removed, as it is deprecated and will no longer be supported in future npm releases. To ensure your workflows continue to run without warnings or errors, please remove any references to `always-auth` from your configuration.
19+
- The `always-auth` input has been removed, as it is deprecated and will no longer be supported in future npm releases. To ensure your workflows continue to run without warnings or errors, please remove any references to `always-auth` from your configuration.
2020

21-
## Breaking changes in V5
21+
## Breaking changes in V5
2222

2323
- Enabled caching by default with package manager detection if no cache input is provided.
2424
> For workflows with elevated privileges or access to sensitive information, we recommend disabling automatic caching by setting `package-manager-cache: false` when caching is not needed for secure operation.
@@ -42,22 +42,22 @@ See [action.yml](action.yml)
4242
node-version: ''
4343

4444
# File containing the version Spec of the version to use. Examples: package.json, .nvmrc, .node-version, .tool-versions.
45-
# If node-version and node-version-file are both provided the action will use version from node-version.
45+
# If node-version and node-version-file are both provided the action will use version from node-version.
4646
node-version-file: ''
4747

48-
# Set this option if you want the action to check for the latest available version
48+
# Set this option if you want the action to check for the latest available version
4949
# that satisfies the version spec.
50-
# It will only get affect for lts Nodejs versions (12.x, >=10.15.0, lts/Hydrogen).
50+
# It will only get affect for lts Nodejs versions (12.x, >=10.15.0, lts/Hydrogen).
5151
# Default: false
5252
check-latest: false
5353

5454
# Target architecture for Node to use. Examples: x86, x64. Will use system architecture by default.
55-
# Default: ''. The action use system architecture by default
55+
# Default: ''. The action use system architecture by default
5656
architecture: ''
5757

58-
# Used to pull node distributions from https://github.com/actions/node-versions.
59-
# Since there's a default, this is typically not supplied by the user.
60-
# When running this action on github.com, the default value is sufficient.
58+
# Used to pull node distributions from https://github.com/actions/node-versions.
59+
# Since there's a default, this is typically not supplied by the user.
60+
# When running this action on github.com, the default value is sufficient.
6161
# When running on GHES, you can pass a personal access token for github.com if you are experiencing rate limiting.
6262
#
6363
# We recommend using a service account with the least permissions necessary. Also
@@ -78,26 +78,26 @@ See [action.yml](action.yml)
7878
# default: true
7979
package-manager-cache: true
8080

81-
# Used to specify the path to a dependency file: package-lock.json, yarn.lock, etc.
82-
# It will generate hash from the target file for primary key. It works only If cache is specified.
81+
# Used to specify the path to a dependency file: package-lock.json, yarn.lock, etc.
82+
# It will generate hash from the target file for primary key. It works only If cache is specified.
8383
# Supports wildcards or a list of file names for caching multiple dependencies.
8484
# Default: ''
8585
cache-dependency-path: ''
8686

87-
# Optional registry to set up for auth. Will set the registry in a project level .npmrc and .yarnrc file,
87+
# Optional registry to set up for auth. Will set the registry in a project level .npmrc and .yarnrc file,
8888
# and set up auth to read in from env.NODE_AUTH_TOKEN.
8989
# Default: ''
9090
registry-url: ''
9191

92-
# Optional scope for authenticating against scoped registries.
92+
# Optional scope for authenticating against scoped registries.
9393
# Will fall back to the repository owner when using the GitHub Packages registry (https://npm.pkg.github.com/).
9494
# Default: ''
9595
scope: ''
9696

9797
# Optional mirror to download binaries from.
9898
# Artifacts need to match the official Node.js
9999
# Example:
100-
# V8 Canaray Build: <mirror_url>/download/v8-canary
100+
# V8 Canary Build: <mirror_url>/download/v8-canary
101101
# RC Build: <mirror_url>/download/rc
102102
# Official: Build <mirror_url>/dist
103103
# Nightly build: <mirror_url>/download/nightly

action.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,13 +26,13 @@ inputs:
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
mirror:
29-
description: 'Used to specify an alternative mirror to downlooad Node.js binaries from'
29+
description: 'Used to specify an alternative mirror to download Node.js binaries from'
3030
mirror-token:
3131
description: 'The token used as Authorization header when fetching from the mirror'
3232
# TODO: add input to control forcing to pull from cloud or dist.
3333
# escape valve for someone having issues or needing the absolute latest which isn't cached yet
3434
outputs:
35-
cache-hit:
35+
cache-hit:
3636
description: 'A boolean value to indicate if a cache was hit.'
3737
node-version:
3838
description: 'The installed node version.'

0 commit comments

Comments
 (0)