From 86bf502a33df3d7ca5daace2b5d63c9877c85c28 Mon Sep 17 00:00:00 2001 From: Philipp Bammes <8144115+tyrann0us@users.noreply.github.com> Date: Tue, 19 Apr 2022 19:43:19 +0200 Subject: [PATCH 1/3] extend documentation on `scope` parameter (#470) This also ends all descriptions with a full stop (`.`). --- action.yml | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/action.yml b/action.yml index 41e45d2d..7bed73dc 100644 --- a/action.yml +++ b/action.yml @@ -1,35 +1,35 @@ name: 'Setup Node.js environment' -description: 'Setup a Node.js environment by adding problem matchers and optionally downloading and adding it to the PATH' +description: 'Setup a Node.js environment by adding problem matchers and optionally downloading and adding it to the PATH.' author: 'GitHub' inputs: always-auth: - description: 'Set always-auth in npmrc' + description: 'Set always-auth in npmrc.' default: 'false' node-version: - description: 'Version Spec of the version to use. Examples: 12.x, 10.15.1, >=10.15.0' + description: 'Version Spec of the version to use. Examples: 12.x, 10.15.1, >=10.15.0.' node-version-file: - description: 'File containing the version Spec of the version to use. Examples: .nvmrc, .node-version' + description: 'File containing the version Spec of the version to use. Examples: .nvmrc, .node-version.' architecture: description: 'Target architecture for Node to use. Examples: x86, x64. Will use system architecture by default.' check-latest: - description: 'Set this option if you want the action to check for the latest available version that satisfies the version spec' + description: 'Set this option if you want the action to check for the latest available version that satisfies the version spec.' default: false registry-url: - 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' + 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.' scope: - description: 'Optional scope for authenticating against scoped registries' + 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/).' token: description: Used to pull node distributions from node-versions. Since there's a default, this is typically not supplied by the user. default: ${{ github.token }} cache: - description: 'Used to specify a package manager for caching in the default directory. Supported values: npm, yarn, pnpm' + description: 'Used to specify a package manager for caching in the default directory. Supported values: npm, yarn, pnpm.' cache-dependency-path: 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.' # TODO: add input to control forcing to pull from cloud or dist. # escape valve for someone having issues or needing the absolute latest which isn't cached yet outputs: cache-hit: - description: 'A boolean value to indicate if a cache was hit' + description: 'A boolean value to indicate if a cache was hit.' runs: using: 'node16' main: 'dist/setup/index.js' From 337fdf2194d3e87cdd26672305866d19d404fcd3 Mon Sep 17 00:00:00 2001 From: Araxeus Date: Fri, 22 Apr 2022 15:58:19 +0300 Subject: [PATCH 2/3] fix broken link in readme (#473) * fix broken link * fix broken link --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e997b92e..1460e240 100644 --- a/README.md +++ b/README.md @@ -49,7 +49,7 @@ The action defaults to search for the dependency file (`package-lock.json` or `y **Note:** The action does not cache `node_modules` -See the examples of using cache for `yarn` / `pnpm` and `cache-dependency-path` input in the [Advanced usage](docs/advanced-usage.md#caching-packages-dependencies) guide. +See the examples of using cache for `yarn` / `pnpm` and `cache-dependency-path` input in the [Advanced usage](docs/advanced-usage.md#caching-packages-data) guide. **Caching npm dependencies:** @@ -103,7 +103,7 @@ jobs: 1. [Check latest version](docs/advanced-usage.md#check-latest-version) 2. [Using a node version file](docs/advanced-usage.md#node-version-file) 3. [Using different architectures](docs/advanced-usage.md#architecture) -4. [Caching packages data](docs/advanced-usage.md#caching-packages-dependencies) +4. [Caching packages data](docs/advanced-usage.md#caching-packages-data) 5. [Using multiple operating systems and architectures](docs/advanced-usage.md#multiple-operating-systems-and-architectures) 6. [Publishing to npmjs and GPR with npm](docs/advanced-usage.md#publish-to-npmjs-and-gpr-with-npm) 7. [Publishing to npmjs and GPR with yarn](docs/advanced-usage.md#publish-to-npmjs-and-gpr-with-yarn) From 25184c4485a7b08d05f0d0a07d714e3611e40d38 Mon Sep 17 00:00:00 2001 From: Adam Stachowicz Date: Tue, 26 Apr 2022 15:11:03 +0000 Subject: [PATCH 3/3] Update README.md (#475) * Update README.md * Update README.md --- README.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 1460e240..4c6ff06e 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ This action provides the following functionality for GitHub Actions users: - Registering problem matchers for error output - Configuring authentication for GPR or npm -# Usage +## Usage See [action.yml](action.yml) @@ -22,7 +22,7 @@ steps: - uses: actions/checkout@v3 - uses: actions/setup-node@v3 with: - node-version: '14' + node-version: 14 - run: npm install - run: npm test ``` @@ -33,7 +33,7 @@ The action will first check the local cache for a semver match. If unable to fin For information regarding locally cached versions of Node.js on GitHub hosted runners, check out [GitHub Actions Virtual Environments](https://github.com/actions/virtual-environments). -#### Supported version syntax +### Supported version syntax The `node-version` input supports the following syntax: @@ -49,7 +49,7 @@ The action defaults to search for the dependency file (`package-lock.json` or `y **Note:** The action does not cache `node_modules` -See the examples of using cache for `yarn` / `pnpm` and `cache-dependency-path` input in the [Advanced usage](docs/advanced-usage.md#caching-packages-data) guide. +See the examples of using cache for `yarn`/`pnpm` and `cache-dependency-path` input in the [Advanced usage](docs/advanced-usage.md#caching-packages-data) guide. **Caching npm dependencies:** @@ -58,7 +58,7 @@ steps: - uses: actions/checkout@v3 - uses: actions/setup-node@v3 with: - node-version: '14' + node-version: 14 cache: 'npm' - run: npm install - run: npm test @@ -71,14 +71,14 @@ steps: - uses: actions/checkout@v3 - uses: actions/setup-node@v3 with: - node-version: '14' + node-version: 14 cache: 'npm' cache-dependency-path: subdir/package-lock.json - run: npm install - run: npm test ``` -## Matrix Testing: +## Matrix Testing ```yaml jobs: @@ -86,7 +86,7 @@ jobs: runs-on: ubuntu-latest strategy: matrix: - node: [ '12', '14', '16' ] + node: [ 12, 14, 16 ] name: Node ${{ matrix.node }} sample steps: - uses: actions/checkout@v3 @@ -109,14 +109,14 @@ jobs: 7. [Publishing to npmjs and GPR with yarn](docs/advanced-usage.md#publish-to-npmjs-and-gpr-with-yarn) 8. [Using private packages](docs/advanced-usage.md#use-private-packages) -# License +## License The scripts and documentation in this project are released under the [MIT License](LICENSE) -# Contributions +## Contributions -Contributions are welcome! See [Contributor's Guide](docs/contributors.md) +Contributions are welcome! See [Contributor's Guide](docs/contributors.md) ## Code of Conduct -:wave: Be nice. See [our code of conduct](CODE_OF_CONDUCT.md) +:wave: Be nice. See [our code of conduct](CODE_OF_CONDUCT.md)