Compare commits

..

3 Commits

Author SHA1 Message Date
62fdfbb318 Update README to include yarn
A user indicated that it was not clear that the `setup-node` action took care of yarn, and tried using an incompatible third-party action.  Better specify that yarn is included above the fold.
2019-10-18 11:36:35 +01:00
466ce3c2f0 Update README.md 2019-10-11 10:27:02 -04:00
e565252a9d Fixing checkout to reference v1 in readme 2019-09-12 15:54:53 -04:00

View File

@ -4,10 +4,11 @@
<a href="https://github.com/actions/setup-node"><img alt="GitHub Actions status" src="https://github.com/actions/setup-node/workflows/Main%20workflow/badge.svg"></a>
</p>
This action sets by node environment for use in actions by:
This action sets up a node environment for use in actions, including npm and yarn. It:
- optionally downloading and caching a version of node - npm by version spec and add to PATH
- registering problem matchers for error output
- sets up the specified version of node (downloading it if it's not already available)
- adds node, npm and yarn to the PATH
- registers problem matchers for error output
# Usage
@ -16,7 +17,7 @@ See [action.yml](action.yml)
Basic:
```yaml
steps:
- uses: actions/checkout@master
- uses: actions/checkout@v1
- uses: actions/setup-node@v1
with:
node-version: '10.x'
@ -34,7 +35,7 @@ jobs:
node: [ '10', '8' ]
name: Node ${{ matrix.node }} sample
steps:
- uses: actions/checkout@master
- uses: actions/checkout@v1
- name: Setup node
uses: actions/setup-node@v1
with:
@ -46,7 +47,7 @@ jobs:
Publish to npmjs and GPR with npm:
```yaml
steps:
- uses: actions/checkout@master
- uses: actions/checkout@v1
- uses: actions/setup-node@v1
with:
node-version: '10.x'
@ -66,7 +67,7 @@ steps:
Publish to npmjs and GPR with yarn:
```yaml
steps:
- uses: actions/checkout@master
- uses: actions/checkout@v1
- uses: actions/setup-node@v1
with:
node-version: '10.x'
@ -86,7 +87,7 @@ steps:
Use private packages:
```yaml
steps:
- uses: actions/checkout@master
- uses: actions/checkout@v1
- uses: actions/setup-node@v1
with:
node-version: '10.x'