Skip to content

Commit

Permalink
Update README.md (#475)
Browse files Browse the repository at this point in the history
* Update README.md

* Update README.md
  • Loading branch information
Saibamen committed Apr 26, 2022
1 parent 337fdf2 commit 25184c4
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions README.md
Expand Up @@ -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)

Expand All @@ -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
```
Expand All @@ -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:

Expand All @@ -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:**

Expand All @@ -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
Expand All @@ -71,22 +71,22 @@ 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:
build:
runs-on: ubuntu-latest
strategy:
matrix:
node: [ '12', '14', '16' ]
node: [ 12, 14, 16 ]
name: Node ${{ matrix.node }} sample
steps:
- uses: actions/checkout@v3
Expand All @@ -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)

0 comments on commit 25184c4

Please sign in to comment.