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
Merged

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

Show file tree
Hide file tree
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
refactor: move volta logic
  • Loading branch information
@jef
jef committed Jun 29, 2022
commit dbfbe9b6dab362ff4d3dacc32758182a21c603bf
24 changes: 20 additions & 4 deletions __tests__/installer.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -560,7 +560,7 @@ describe('setup-node', () => {
expect(parseNodeVersionSpy).toHaveBeenCalledTimes(0);
});

it('reads node-version-file if provided', async () => {
it('reads node-version-file if provided (.nvmrc)', async () => {
// Arrange
const versionSpec = 'v14';
const versionFile = '.nvmrc';
Expand All @@ -572,6 +572,7 @@ describe('setup-node', () => {
existsSpy.mockImplementationOnce(
input => input === path.join(__dirname, 'data', versionFile)
);

// Act
await main.run();

Expand All @@ -584,22 +585,37 @@ describe('setup-node', () => {
);
});

it('reads node-version-file if provided with volta', async () => {
it('reads node-version-file if provided (package.json, volta)', async () => {
// Arrange
const expectedVersionSpec = '16.15.1';
const versionSpec = `{
"name": "test",
"version": "1.0.0",
"private": true,
"scripts": {
"test": "echo test"
},
"volta": {
"node": "16.15.1"
}
}
`;
const versionFile = 'package.json';
const expectedVersionSpec = '16.15.1';
process.env['GITHUB_WORKSPACE'] = path.join(__dirname, 'data');
inputs['node-version-file'] = 'volta';
inputs['node-version-file'] = versionFile;

parseNodeVersionSpy.mockImplementation(() => expectedVersionSpec);
existsSpy.mockImplementationOnce(
input => input === path.join(__dirname, 'data', versionFile)
);

// Act
await main.run();

// Assert
expect(existsSpy).toHaveBeenCalledTimes(1);
expect(existsSpy).toHaveReturnedWith(true);
expect(parseNodeVersionSpy).toHaveBeenCalledWith(versionSpec);
expect(logSpy).toHaveBeenCalledWith(
`Resolved ${versionFile} as ${expectedVersionSpec}`
);
Expand Down
18 changes: 9 additions & 9 deletions dist/setup/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71768,7 +71768,13 @@ function translateArchToDistUrl(arch) {
}
}
function parseNodeVersionFile(contents) {
let nodeVersion = contents.trim();
let nodeVersion;
if (contents.includes('volta')) {
nodeVersion = JSON.parse(contents).volta.node;
}
else {
nodeVersion = contents.trim();
}
if (/^v\d/.test(nodeVersion)) {
nodeVersion = nodeVersion.substring(1);
}
Expand Down Expand Up @@ -71862,8 +71868,7 @@ function run() {
exports.run = run;
function resolveVersionInput() {
let version = core.getInput('node-version');
const nodeVersionFile = core.getInput('node-version-file');
const versionFileInput = nodeVersionFile === 'volta' ? 'package.json' : nodeVersionFile;
const versionFileInput = core.getInput('node-version-file');
if (version && versionFileInput) {
core.warning('Both node-version and node-version-file inputs are specified, only node-version will be used');
}
Expand All @@ -71875,12 +71880,7 @@ function resolveVersionInput() {
if (!fs_1.default.existsSync(versionFilePath)) {
throw new Error(`The specified node version file at: ${versionFilePath} does not exist`);
}
if (nodeVersionFile === 'volta') {
version = JSON.parse(fs_1.default.readFileSync(versionFilePath, 'utf8')).volta.node;
}
else {
version = installer.parseNodeVersionFile(fs_1.default.readFileSync(versionFilePath, 'utf8'));
}
version = installer.parseNodeVersionFile(fs_1.default.readFileSync(versionFilePath, 'utf8'));
core.info(`Resolved ${versionFileInput} as ${version}`);
}
return version;
Expand Down
8 changes: 7 additions & 1 deletion src/installer.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -495,7 +495,13 @@ function translateArchToDistUrl(arch: string): string {
}

export function parseNodeVersionFile(contents: string): string {
let nodeVersion = contents.trim();
let nodeVersion;

if (contents.includes('volta')) {
nodeVersion = JSON.parse(contents).volta.node;
} else {
nodeVersion = contents.trim();
}

if (/^v\d/.test(nodeVersion)) {
nodeVersion = nodeVersion.substring(1);
Expand Down
14 changes: 4 additions & 10 deletions src/main.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,9 +65,7 @@ export async function run() {

function resolveVersionInput(): string {
let version = core.getInput('node-version');
const nodeVersionFile = core.getInput('node-version-file');
const versionFileInput =
nodeVersionFile === 'volta' ? 'package.json' : nodeVersionFile;
const versionFileInput = core.getInput('node-version-file');

if (version && versionFileInput) {
core.warning(
Expand All @@ -91,13 +89,9 @@ function resolveVersionInput(): string {
);
}

if (nodeVersionFile === 'volta') {
version = JSON.parse(fs.readFileSync(versionFilePath, 'utf8')).volta.node;
} else {
version = installer.parseNodeVersionFile(
fs.readFileSync(versionFilePath, 'utf8')
);
}
version = installer.parseNodeVersionFile(
fs.readFileSync(versionFilePath, 'utf8')
);

core.info(`Resolved ${versionFileInput} as ${version}`);
}
Expand Down