mirror of
				https://github.com/actions/setup-node.git
				synced 2025-11-04 06:43:35 +00:00 
			
		
		
		
	docs: add docs
This commit is contained in:
		
							parent
							
								
									41bb914692
								
							
						
					
					
						commit
						872987f82b
					
				@ -138,6 +138,7 @@ If the runner is not able to access github.com, any Nodejs versions requested du
 | 
				
			|||||||
8. [Publishing to npmjs and GPR with npm](docs/advanced-usage.md#publish-to-npmjs-and-gpr-with-npm)
 | 
					8. [Publishing to npmjs and GPR with npm](docs/advanced-usage.md#publish-to-npmjs-and-gpr-with-npm)
 | 
				
			||||||
9. [Publishing to npmjs and GPR with yarn](docs/advanced-usage.md#publish-to-npmjs-and-gpr-with-yarn)
 | 
					9. [Publishing to npmjs and GPR with yarn](docs/advanced-usage.md#publish-to-npmjs-and-gpr-with-yarn)
 | 
				
			||||||
10. [Using private packages](docs/advanced-usage.md#use-private-packages)
 | 
					10. [Using private packages](docs/advanced-usage.md#use-private-packages)
 | 
				
			||||||
 | 
					11. [Enabling Corepack](docs/advanced-usage.md#enabling-corepack)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
## License
 | 
					## License
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
				
			|||||||
@ -358,3 +358,32 @@ NOTE: As per https://github.com/actions/setup-node/issues/49 you cannot use `sec
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
### always-auth input
 | 
					### always-auth input
 | 
				
			||||||
The always-auth input sets `always-auth=true` in .npmrc file. With this option set [npm](https://docs.npmjs.com/cli/v6/using-npm/config#always-auth)/yarn sends the authentication credentials when making a request to the registries.
 | 
					The always-auth input sets `always-auth=true` in .npmrc file. With this option set [npm](https://docs.npmjs.com/cli/v6/using-npm/config#always-auth)/yarn sends the authentication credentials when making a request to the registries.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					## Enabling Corepack
 | 
				
			||||||
 | 
					You can enable [Corepack](https://github.com/nodejs/corepack) by using the `corepack` input. This will enable Corepack. You can then use `pnpm` and `yarn` commands in your project.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					```yaml
 | 
				
			||||||
 | 
					steps:
 | 
				
			||||||
 | 
					- uses: actions/checkout@v3
 | 
				
			||||||
 | 
					- uses: actions/setup-node@v3
 | 
				
			||||||
 | 
					  with:
 | 
				
			||||||
 | 
					    node-version: '16.x'
 | 
				
			||||||
 | 
					    corepack: true
 | 
				
			||||||
 | 
					- name: Install dependencies
 | 
				
			||||||
 | 
					  run: yarn install --immutable
 | 
				
			||||||
 | 
					```
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					You can also pass package manager names instead if you want to enable corepack for specific package managers only.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					```yaml
 | 
				
			||||||
 | 
					steps:
 | 
				
			||||||
 | 
					- uses: actions/checkout@v3
 | 
				
			||||||
 | 
					- uses: actions/setup-node@v3
 | 
				
			||||||
 | 
					  with:
 | 
				
			||||||
 | 
					    node-version: '16.x'
 | 
				
			||||||
 | 
					    corepack: yarn pnpm
 | 
				
			||||||
 | 
					- name: Install dependencies
 | 
				
			||||||
 | 
					  run: yarn install --immutable
 | 
				
			||||||
 | 
					```
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					This option by default is `false` as Corepack is still in experimental phase.
 | 
				
			||||||
 | 
				
			|||||||
		Loading…
	
	
			
			x
			
			
		
	
		Reference in New Issue
	
	Block a user