mirror of
				https://github.com/actions/setup-node.git
				synced 2025-11-04 21:39:11 +08:00 
			
		
		
		
	update readme and dist files
This commit is contained in:
		@@ -1,6 +1,6 @@
 | 
			
		||||
# Advanced usage
 | 
			
		||||
 | 
			
		||||
### Check latest version
 | 
			
		||||
## Check latest version
 | 
			
		||||
 | 
			
		||||
The `check-latest` flag defaults to `false`. When set to `false`, the action will first check the local cache for a semver match. If unable to find a specific version in the cache, the action will attempt to download a version of Node.js. It will pull LTS versions from [node-versions releases](https://github.com/actions/node-versions/releases) and on miss or failure will fall back to the previous behavior of downloading directly from [node dist](https://nodejs.org/dist/). Use the default or set `check-latest` to `false` if you prefer stability and if you want to ensure a specific version of Node.js is always used.
 | 
			
		||||
 | 
			
		||||
@@ -19,7 +19,7 @@ steps:
 | 
			
		||||
- run: npm test
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
### Architecture
 | 
			
		||||
## Architecture
 | 
			
		||||
 | 
			
		||||
You can use any of the [supported operating systems](https://docs.github.com/en/actions/reference/virtual-environments-for-github-hosted-runners), and the compatible `architecture` can be selected using `architecture`. Values are `x86`, `x64`, `arm64`, `armv6l`, `armv7l`, `ppc64le`, `s390x` (not all of the architectures are available on all platforms).
 | 
			
		||||
 | 
			
		||||
@@ -39,7 +39,43 @@ jobs:
 | 
			
		||||
      - run: npm test
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
### Caching packages dependencies
 | 
			
		||||
## Caching packages dependencies
 | 
			
		||||
The action follows [actions/cache](https://github.com/actions/cache/blob/main/examples.md#node---npm) guidelines, and caches global cache on the machine instead of `node_modules`, so cache can be reused between different Node.js versions.
 | 
			
		||||
 | 
			
		||||
**Caching yarn dependencies:**  
 | 
			
		||||
Yarn caching handles both yarn versions: 1 or 2.
 | 
			
		||||
```yaml
 | 
			
		||||
steps:
 | 
			
		||||
- uses: actions/checkout@v2
 | 
			
		||||
- uses: actions/setup-node@v2
 | 
			
		||||
  with:
 | 
			
		||||
    node-version: '14'
 | 
			
		||||
    cache: 'yarn'
 | 
			
		||||
- run: yarn install
 | 
			
		||||
- run: yarn test
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
**Caching pnpm (v6.10+) dependencies:**
 | 
			
		||||
```yaml
 | 
			
		||||
# This workflow uses actions that are not certified by GitHub.
 | 
			
		||||
# They are provided by a third-party and are governed by
 | 
			
		||||
# separate terms of service, privacy policy, and support
 | 
			
		||||
# documentation.
 | 
			
		||||
 | 
			
		||||
# NOTE: pnpm caching support requires pnpm version >= 6.10.0
 | 
			
		||||
 | 
			
		||||
steps:
 | 
			
		||||
- uses: actions/checkout@v2
 | 
			
		||||
- uses: pnpm/action-setup@646cdf48217256a3d0b80361c5a50727664284f2
 | 
			
		||||
  with:
 | 
			
		||||
    version: 6.10.0
 | 
			
		||||
- uses: actions/setup-node@v2
 | 
			
		||||
  with:
 | 
			
		||||
    node-version: '14'
 | 
			
		||||
    cache: 'pnpm'
 | 
			
		||||
- run: pnpm install
 | 
			
		||||
- run: pnpm test
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
**Using wildcard patterns to cache dependencies**
 | 
			
		||||
```yaml
 | 
			
		||||
@@ -69,7 +105,7 @@ steps:
 | 
			
		||||
- run: npm test
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
### Multiple Operating Systems and Architectures
 | 
			
		||||
## Multiple Operating Systems and Architectures
 | 
			
		||||
 | 
			
		||||
```yaml
 | 
			
		||||
jobs:
 | 
			
		||||
@@ -104,7 +140,7 @@ jobs:
 | 
			
		||||
      - run: npm test
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
### Publish to npmjs and GPR with npm
 | 
			
		||||
## Publish to npmjs and GPR with npm
 | 
			
		||||
```yaml
 | 
			
		||||
steps:
 | 
			
		||||
- uses: actions/checkout@v2
 | 
			
		||||
@@ -124,7 +160,7 @@ steps:
 | 
			
		||||
    NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
### Publish to npmjs and GPR with yarn
 | 
			
		||||
## Publish to npmjs and GPR with yarn
 | 
			
		||||
```yaml
 | 
			
		||||
steps:
 | 
			
		||||
- uses: actions/checkout@v2
 | 
			
		||||
@@ -144,7 +180,7 @@ steps:
 | 
			
		||||
    NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
### Use private packages
 | 
			
		||||
## Use private packages
 | 
			
		||||
```yaml
 | 
			
		||||
steps:
 | 
			
		||||
- uses: actions/checkout@v2
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user