Skip to content

Commit f6164bd

Browse files
dmitry-shibanovdmitry-shibanov
authored
Remove stable input and fix SemVer notation (#195)
1 parent 2bb2aab commit f6164bd

File tree

6 files changed

+69
-91
lines changed

6 files changed

+69
-91
lines changed

‎__tests__/setup-go.test.ts

Lines changed: 14 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ describe('setup-go', () => {
147147
os.arch = 'x64';
148148

149149
// spec: 1.13.0 => 1.13
150-
let match: im.IGoVersion | undefined = await im.findMatch('1.13.0', true);
150+
let match: im.IGoVersion | undefined = await im.findMatch('1.13.0');
151151
expect(match).toBeDefined();
152152
let version: string = match ? match.version : '';
153153
expect(version).toBe('go1.13');
@@ -160,7 +160,7 @@ describe('setup-go', () => {
160160
os.arch = 'x64';
161161

162162
// spec: 1.13 => 1.13.7 (latest)
163-
let match: im.IGoVersion | undefined = await im.findMatch('1.13', true);
163+
let match: im.IGoVersion | undefined = await im.findMatch('1.13');
164164
expect(match).toBeDefined();
165165
let version: string = match ? match.version : '';
166166
expect(version).toBe('go1.13.7');
@@ -173,7 +173,7 @@ describe('setup-go', () => {
173173
os.arch = 'x64';
174174

175175
// spec: ^1.13.6 => 1.13.7
176-
let match: im.IGoVersion | undefined = await im.findMatch('^1.13.6', true);
176+
let match: im.IGoVersion | undefined = await im.findMatch('^1.13.6');
177177
expect(match).toBeDefined();
178178
let version: string = match ? match.version : '';
179179
expect(version).toBe('go1.13.7');
@@ -186,7 +186,7 @@ describe('setup-go', () => {
186186
os.arch = 'x32';
187187

188188
// spec: 1 => 1.13.7 (latest)
189-
let match: im.IGoVersion | undefined = await im.findMatch('1', true);
189+
let match: im.IGoVersion | undefined = await im.findMatch('1');
190190
expect(match).toBeDefined();
191191
let version: string = match ? match.version : '';
192192
expect(version).toBe('go1.13.7');
@@ -199,10 +199,7 @@ describe('setup-go', () => {
199199
os.arch = 'x64';
200200

201201
// spec: 1.14, stable=false => go1.14rc1
202-
let match: im.IGoVersion | undefined = await im.findMatch(
203-
'1.14.0-rc1',
204-
false
205-
);
202+
let match: im.IGoVersion | undefined = await im.findMatch('1.14.0-rc.1');
206203
expect(match).toBeDefined();
207204
let version: string = match ? match.version : '';
208205
expect(version).toBe('go1.14rc1');
@@ -218,7 +215,7 @@ describe('setup-go', () => {
218215
findSpy.mockImplementation(() => toolPath);
219216
await main.run();
220217

221-
expect(logSpy).toHaveBeenCalledWith(`Setup go stable version spec 1.13.0`);
218+
expect(logSpy).toHaveBeenCalledWith(`Setup go version spec 1.13.0`);
222219
});
223220

224221
it('evaluates to stable with no input', async () => {
@@ -230,7 +227,7 @@ describe('setup-go', () => {
230227
findSpy.mockImplementation(() => toolPath);
231228
await main.run();
232229

233-
expect(logSpy).toHaveBeenCalledWith(`Setup go stable version spec 1.13.0`);
230+
expect(logSpy).toHaveBeenCalledWith(`Setup go version spec 1.13.0`);
234231
});
235232

236233
it('finds a version of go already in the cache', async () => {
@@ -396,7 +393,7 @@ describe('setup-go', () => {
396393
await main.run();
397394

398395
let expPath = path.join(toolPath, 'bin');
399-
expect(logSpy).toHaveBeenCalledWith('Setup go stable version spec 1.12.14');
396+
expect(logSpy).toHaveBeenCalledWith('Setup go version spec 1.12.14');
400397
expect(findSpy).toHaveBeenCalled();
401398
expect(logSpy).toHaveBeenCalledWith('Attempting to download 1.12.14...');
402399
expect(dlSpy).toHaveBeenCalled();
@@ -560,11 +557,11 @@ describe('setup-go', () => {
560557

561558
// 1.13.1 => 1.13.1
562559
// 1.13 => 1.13.0
563-
// 1.10beta1 => 1.10.0-beta1, 1.10rc1 => 1.10.0-rc1
564-
// 1.8.5beta1 => 1.8.5-beta1, 1.8.5rc1 => 1.8.5-rc1
560+
// 1.10beta1 => 1.10.0-beta.1, 1.10rc1 => 1.10.0-rc.1
561+
// 1.8.5beta1 => 1.8.5-beta.1, 1.8.5rc1 => 1.8.5-rc.1
565562
it('converts prerelease versions', async () => {
566-
expect(im.makeSemver('1.10beta1')).toBe('1.10.0-beta1');
567-
expect(im.makeSemver('1.10rc1')).toBe('1.10.0-rc1');
563+
expect(im.makeSemver('1.10beta1')).toBe('1.10.0-beta.1');
564+
expect(im.makeSemver('1.10rc1')).toBe('1.10.0-rc.1');
568565
});
569566

570567
it('converts dot zero versions', async () => {
@@ -608,7 +605,7 @@ describe('setup-go', () => {
608605

609606
await main.run();
610607

611-
expect(logSpy).toHaveBeenCalledWith('Setup go stable version spec 1.16');
608+
expect(logSpy).toHaveBeenCalledWith('Setup go version spec 1.16');
612609
expect(logSpy).toHaveBeenCalledWith(`Found in cache @ ${toolPath}`);
613610
});
614611

@@ -633,7 +630,7 @@ describe('setup-go', () => {
633630
await main.run();
634631

635632
expect(logSpy).toHaveBeenCalledWith(
636-
`Setup go stable version spec ${versionSpec}`
633+
`Setup go version spec ${versionSpec}`
637634
);
638635
expect(logSpy).toHaveBeenCalledWith(
639636
'Attempting to resolve the latest version from the manifest...'

‎action.yml

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,6 @@ inputs:
77
check-latest:
88
description: 'Set this option to true if you want the action to always check for the latest available version that satisfies the version spec'
99
default: false
10-
stable:
11-
description: 'Whether to download only stable versions'
12-
default: 'true'
1310
token:
1411
description: Used to pull node distributions from go-versions. Since there's a default, this is typically not supplied by the user.
1512
default: ${{ github.token }}

‎dist/index.js

Lines changed: 26 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -2074,15 +2074,12 @@ function run() {
20742074
// If not supplied then problem matchers will still be setup. Useful for self-hosted.
20752075
//
20762076
let versionSpec = core.getInput('go-version');
2077-
// stable will be true unless false is the exact input
2078-
// since getting unstable versions should be explicit
2079-
let stable = (core.getInput('stable') || 'true').toUpperCase() === 'TRUE';
2080-
core.info(`Setup go ${stable ? 'stable' : ''} version spec ${versionSpec}`);
2077+
core.info(`Setup go version spec ${versionSpec}`);
20812078
if (versionSpec) {
20822079
let token = core.getInput('token');
20832080
let auth = !token || isGhes() ? undefined : `token ${token}`;
20842081
const checkLatest = core.getBooleanInput('check-latest');
2085-
const installDir = yield installer.getGo(versionSpec, stable, checkLatest, auth);
2082+
const installDir = yield installer.getGo(versionSpec, checkLatest, auth);
20862083
core.exportVariable('GOROOT', installDir);
20872084
core.addPath(path_1.default.join(installDir, 'bin'));
20882085
core.info('Added go to the path');
@@ -5718,7 +5715,7 @@ module.exports = bytesToUuid;
57185715

57195716
Object.defineProperty(exports, "__esModule", { value: true });
57205717
exports.getArch = exports.getPlatform = void 0;
5721-
let os = __webpack_require__(87);
5718+
const os = __webpack_require__(87);
57225719
function getPlatform() {
57235720
// darwin and linux match already
57245721
// freebsd not supported yet but future proofed.
@@ -5890,13 +5887,13 @@ const semver = __importStar(__webpack_require__(280));
58905887
const httpm = __importStar(__webpack_require__(539));
58915888
const sys = __importStar(__webpack_require__(737));
58925889
const os_1 = __importDefault(__webpack_require__(87));
5893-
function getGo(versionSpec, stable, checkLatest, auth) {
5890+
function getGo(versionSpec, checkLatest, auth) {
58945891
return __awaiter(this, void 0, void 0, function* () {
58955892
let osPlat = os_1.default.platform();
58965893
let osArch = os_1.default.arch();
58975894
if (checkLatest) {
58985895
core.info('Attempting to resolve the latest version from the manifest...');
5899-
const resolvedVersion = yield resolveVersionFromManifest(versionSpec, stable, auth);
5896+
const resolvedVersion = yield resolveVersionFromManifest(versionSpec, true, auth);
59005897
if (resolvedVersion) {
59015898
versionSpec = resolvedVersion;
59025899
core.info(`Resolved as '${versionSpec}'`);
@@ -5920,7 +5917,7 @@ function getGo(versionSpec, stable, checkLatest, auth) {
59205917
// Try download from internal distribution (popular versions only)
59215918
//
59225919
try {
5923-
info = yield getInfoFromManifest(versionSpec, stable, auth);
5920+
info = yield getInfoFromManifest(versionSpec, true, auth);
59245921
if (info) {
59255922
downloadPath = yield installGoVersion(info, auth);
59265923
}
@@ -5943,7 +5940,7 @@ function getGo(versionSpec, stable, checkLatest, auth) {
59435940
// Download from storage.googleapis.com
59445941
//
59455942
if (!downloadPath) {
5946-
info = yield getInfoFromDist(versionSpec, stable);
5943+
info = yield getInfoFromDist(versionSpec);
59475944
if (!info) {
59485945
throw new Error(`Unable to find Go version '${versionSpec}' for platform ${osPlat} and architecture ${osArch}.`);
59495946
}
@@ -6018,10 +6015,10 @@ function getInfoFromManifest(versionSpec, stable, auth) {
60186015
});
60196016
}
60206017
exports.getInfoFromManifest = getInfoFromManifest;
6021-
function getInfoFromDist(versionSpec, stable) {
6018+
function getInfoFromDist(versionSpec) {
60226019
return __awaiter(this, void 0, void 0, function* () {
60236020
let version;
6024-
version = yield findMatch(versionSpec, stable);
6021+
version = yield findMatch(versionSpec);
60256022
if (!version) {
60266023
return null;
60276024
}
@@ -6034,7 +6031,7 @@ function getInfoFromDist(versionSpec, stable) {
60346031
};
60356032
});
60366033
}
6037-
function findMatch(versionSpec, stable) {
6034+
function findMatch(versionSpec) {
60386035
return __awaiter(this, void 0, void 0, function* () {
60396036
let archFilter = sys.getArch();
60406037
let platFilter = sys.getPlatform();
@@ -6049,15 +6046,8 @@ function findMatch(versionSpec, stable) {
60496046
for (let i = 0; i < candidates.length; i++) {
60506047
let candidate = candidates[i];
60516048
let version = makeSemver(candidate.version);
6052-
// 1.13.0 is advertised as 1.13 preventing being able to match exactly 1.13.0
6053-
// since a semver of 1.13 would match latest 1.13
6054-
let parts = version.split('.');
6055-
if (parts.length == 2) {
6056-
version = version + '.0';
6057-
}
60586049
core.debug(`check ${version} satisfies ${versionSpec}`);
6059-
if (semver.satisfies(version, versionSpec) &&
6060-
(!stable || candidate.stable === stable)) {
6050+
if (semver.satisfies(version, versionSpec)) {
60616051
goFile = candidate.files.find(file => {
60626052
core.debug(`${file.arch}===${archFilter} && ${file.os}===${platFilter}`);
60636053
return file.arch === archFilter && file.os === platFilter;
@@ -6093,19 +6083,25 @@ exports.getVersionsDist = getVersionsDist;
60936083
// Convert the go version syntax into semver for semver matching
60946084
// 1.13.1 => 1.13.1
60956085
// 1.13 => 1.13.0
6096-
// 1.10beta1 => 1.10.0-beta1, 1.10rc1 => 1.10.0-rc1
6097-
// 1.8.5beta1 => 1.8.5-beta1, 1.8.5rc1 => 1.8.5-rc1
6086+
// 1.10beta1 => 1.10.0-beta.1, 1.10rc1 => 1.10.0-rc.1
6087+
// 1.8.5beta1 => 1.8.5-beta.1, 1.8.5rc1 => 1.8.5-rc.1
60986088
function makeSemver(version) {
6089+
var _a;
60996090
version = version.replace('go', '');
6100-
version = version.replace('beta', '-beta').replace('rc', '-rc');
6091+
version = version.replace('beta', '-beta.').replace('rc', '-rc.');
61016092
let parts = version.split('-');
6102-
let verPart = parts[0];
6103-
let prereleasePart = parts.length > 1 ? `-${parts[1]}` : '';
6104-
let verParts = verPart.split('.');
6105-
if (verParts.length == 2) {
6106-
verPart += '.0';
6093+
let semVersion = (_a = semver.coerce(parts[0])) === null || _a === void 0 ? void 0 : _a.version;
6094+
if (!semVersion) {
6095+
throw new Error(`The version: ${version} can't be changed to SemVer notation`);
6096+
}
6097+
if (!parts[1]) {
6098+
return semVersion;
6099+
}
6100+
const fullVersion = semver.valid(`${semVersion}-${parts[1]}`);
6101+
if (!fullVersion) {
6102+
throw new Error(`The version: ${version} can't be changed to SemVer notation`);
61076103
}
6108-
return `${verPart}${prereleasePart}`;
6104+
return fullVersion;
61096105
}
61106106
exports.makeSemver = makeSemver;
61116107
//# sourceMappingURL=installer.js.map

‎src/installer.ts

Lines changed: 26 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,6 @@ export interface IGoVersionInfo {
3030

3131
export async function getGo(
3232
versionSpec: string,
33-
stable: boolean,
3433
checkLatest: boolean,
3534
auth: string | undefined
3635
) {
@@ -41,7 +40,7 @@ export async function getGo(
4140
core.info('Attempting to resolve the latest version from the manifest...');
4241
const resolvedVersion = await resolveVersionFromManifest(
4342
versionSpec,
44-
stable,
43+
true,
4544
auth
4645
);
4746
if (resolvedVersion) {
@@ -68,7 +67,7 @@ export async function getGo(
6867
// Try download from internal distribution (popular versions only)
6968
//
7069
try {
71-
info = await getInfoFromManifest(versionSpec, stable, auth);
70+
info = await getInfoFromManifest(versionSpec, true, auth);
7271
if (info) {
7372
downloadPath = await installGoVersion(info, auth);
7473
} else {
@@ -95,7 +94,7 @@ export async function getGo(
9594
// Download from storage.googleapis.com
9695
//
9796
if (!downloadPath) {
98-
info = await getInfoFromDist(versionSpec, stable);
97+
info = await getInfoFromDist(versionSpec);
9998
if (!info) {
10099
throw new Error(
101100
`Unable to find Go version '${versionSpec}' for platform ${osPlat} and architecture ${osArch}.`
@@ -191,11 +190,10 @@ export async function getInfoFromManifest(
191190
}
192191

193192
async function getInfoFromDist(
194-
versionSpec: string,
195-
stable: boolean
193+
versionSpec: string
196194
): Promise<IGoVersionInfo | null> {
197195
let version: IGoVersion | undefined;
198-
version = await findMatch(versionSpec, stable);
196+
version = await findMatch(versionSpec);
199197
if (!version) {
200198
return null;
201199
}
@@ -211,8 +209,7 @@ async function getInfoFromDist(
211209
}
212210

213211
export async function findMatch(
214-
versionSpec: string,
215-
stable: boolean
212+
versionSpec: string
216213
): Promise<IGoVersion | undefined> {
217214
let archFilter = sys.getArch();
218215
let platFilter = sys.getPlatform();
@@ -233,18 +230,8 @@ export async function findMatch(
233230
let candidate: IGoVersion = candidates[i];
234231
let version = makeSemver(candidate.version);
235232

236-
// 1.13.0 is advertised as 1.13 preventing being able to match exactly 1.13.0
237-
// since a semver of 1.13 would match latest 1.13
238-
let parts: string[] = version.split('.');
239-
if (parts.length == 2) {
240-
version = version + '.0';
241-
}
242-
243233
core.debug(`check ${version} satisfies ${versionSpec}`);
244-
if (
245-
semver.satisfies(version, versionSpec) &&
246-
(!stable || candidate.stable === stable)
247-
) {
234+
if (semver.satisfies(version, versionSpec)) {
248235
goFile = candidate.files.find(file => {
249236
core.debug(
250237
`${file.arch}===${archFilter} && ${file.os}===${platFilter}`
@@ -284,20 +271,30 @@ export async function getVersionsDist(
284271
// Convert the go version syntax into semver for semver matching
285272
// 1.13.1 => 1.13.1
286273
// 1.13 => 1.13.0
287-
// 1.10beta1 => 1.10.0-beta1, 1.10rc1 => 1.10.0-rc1
288-
// 1.8.5beta1 => 1.8.5-beta1, 1.8.5rc1 => 1.8.5-rc1
274+
// 1.10beta1 => 1.10.0-beta.1, 1.10rc1 => 1.10.0-rc.1
275+
// 1.8.5beta1 => 1.8.5-beta.1, 1.8.5rc1 => 1.8.5-rc.1
289276
export function makeSemver(version: string): string {
290277
version = version.replace('go', '');
291-
version = version.replace('beta', '-beta').replace('rc', '-rc');
278+
version = version.replace('beta', '-beta.').replace('rc', '-rc.');
292279
let parts = version.split('-');
293280

294-
let verPart: string = parts[0];
295-
let prereleasePart = parts.length > 1 ? `-${parts[1]}` : '';
281+
let semVersion = semver.coerce(parts[0])?.version;
282+
if (!semVersion) {
283+
throw new Error(
284+
`The version: ${version} can't be changed to SemVer notation`
285+
);
286+
}
296287

297-
let verParts: string[] = verPart.split('.');
298-
if (verParts.length == 2) {
299-
verPart += '.0';
288+
if (!parts[1]) {
289+
return semVersion;
300290
}
301291

302-
return `${verPart}${prereleasePart}`;
292+
const fullVersion = semver.valid(`${semVersion}-${parts[1]}`);
293+
294+
if (!fullVersion) {
295+
throw new Error(
296+
`The version: ${version} can't be changed to SemVer notation`
297+
);
298+
}
299+
return fullVersion;
303300
}

‎src/main.ts

Lines changed: 2 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -14,23 +14,14 @@ export async function run() {
1414
//
1515
let versionSpec = core.getInput('go-version');
1616

17-
// stable will be true unless false is the exact input
18-
// since getting unstable versions should be explicit
19-
let stable = (core.getInput('stable') || 'true').toUpperCase() === 'TRUE';
20-
21-
core.info(`Setup go ${stable ? 'stable' : ''} version spec ${versionSpec}`);
17+
core.info(`Setup go version spec ${versionSpec}`);
2218

2319
if (versionSpec) {
2420
let token = core.getInput('token');
2521
let auth = !token || isGhes() ? undefined : `token ${token}`;
2622

2723
const checkLatest = core.getBooleanInput('check-latest');
28-
const installDir = await installer.getGo(
29-
versionSpec,
30-
stable,
31-
checkLatest,
32-
auth
33-
);
24+
const installDir = await installer.getGo(versionSpec, checkLatest, auth);
3425

3526
core.exportVariable('GOROOT', installDir);
3627
core.addPath(path.join(installDir, 'bin'));

0 commit comments

Comments
 (0)