Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add volta as node-version-file #532

Merged
merged 21 commits into from
Sep 12, 2022
+64 −33
Merged

feat: add volta as node-version-file #532

Changes from 1 commit
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
1a4ff54
feat: add volta as node-version-file
jef Jun 29, 2022
a03d9f0
test: add node-version-file test
jef Jun 29, 2022
f40b608
docs: add special volta usage
jef Jun 29, 2022
9aa8642
chore: run prettier
jef Jun 29, 2022
dbfbe9b
refactor: move volta logic
jef Jun 29, 2022
8211e00
docs: update verbiage for package.json
jef Jun 29, 2022
d86a20e
test: fix versionSpec
jef Jun 30, 2022
1c48dc5
chore: trim no matter what
jef Jun 30, 2022
4096f07
chore: run prettier
jef Jun 30, 2022
5a01179
Merge remote-tracking branch 'upstream/main'
jef Jul 27, 2022
57cec77
refactor: volta check
jef Jul 27, 2022
dee2a96
chore: run build
jef Jul 27, 2022
9f20343
style: change test name
jef Jul 27, 2022
5b579f1
refactor: check volta first, then engine
jef Jul 27, 2022
bb59d50
chore: run prettier
jef Jul 27, 2022
d79e93a
docs: add package.json information
jef Aug 3, 2022
94f88d7
Merge remote-tracking branch 'upstream/main'
jef Aug 4, 2022
3a1b76e
refactor: remove locally caught exceptions
jef Aug 4, 2022
1e6f2cd
test: add volta e2e test
jef Sep 8, 2022
0efefb3
Merge remote-tracking branch 'upstream/main'
jef Sep 8, 2022
4cffe5c
chore: remove sponge usage
jef Sep 8, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
docs: add package.json information
  • Loading branch information
@jef
jef committed Aug 3, 2022
commit d79e93a91d48dfaebe7232991fc16e6886025509
19 changes: 16 additions & 3 deletions docs/advanced-usage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,16 +48,16 @@ steps:
- uses: actions/checkout@v3
- uses: actions/setup-node@v3
with:
node-version: '14'
node-version: '16'
check-latest: true
- run: npm ci
- run: npm test
```

## Node version file

The `node-version-file` input accepts a path to a file containing the version of Node.js to be used by a project, for example `.nvmrc`, `.node-version` or `.tool-versions`. If both the `node-version` and the `node-version-file` inputs are provided then the `node-version` input is used.
See [supported version syntax](https://github.com/actions/setup-node#supported-version-syntax)
The `node-version-file` input accepts a path to a file containing the version of Node.js to be used by a project, for example `.nvmrc`, `.node-version`, `.tool-versions`, or `package.json`. If both the `node-version` and the `node-version-file` inputs are provided then the `node-version` input is used.
See [supported version syntax](https://github.com/actions/setup-node#supported-version-syntax).

> The action will search for the node version file relative to the repository root.

Expand All @@ -71,6 +71,19 @@ steps:
- run: npm test
```

When using the `package.json` input, the action will look for `volta.node` first. If `volta.node` isn't defined, then it will look for `engines.node`.

```json
{
"engines": {
"node": ">=16.0.0"
},
"volta": {
"node": "16.0.0"
}
}
```

## 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).
Expand Down