mirror of
				https://github.com/actions/setup-node.git
				synced 2025-11-04 19:38:22 +08:00 
			
		
		
		
	Support LTS aliases
This commit is contained in:
		@@ -2,6 +2,7 @@
 | 
			
		||||
    {
 | 
			
		||||
      "version": "14.0.0",
 | 
			
		||||
      "stable": true,
 | 
			
		||||
      "lts": "Fermium",
 | 
			
		||||
      "release_url": "https://github.com/actions/node-versions/releases/tag/14.0.0-20200423.30",
 | 
			
		||||
      "files": [
 | 
			
		||||
        {
 | 
			
		||||
@@ -52,6 +53,7 @@
 | 
			
		||||
    {
 | 
			
		||||
      "version": "12.16.2",
 | 
			
		||||
      "stable": true,
 | 
			
		||||
      "lts": "Erbium",
 | 
			
		||||
      "release_url": "https://github.com/actions/node-versions/releases/tag/12.16.2-20200423.28",
 | 
			
		||||
      "files": [
 | 
			
		||||
        {
 | 
			
		||||
@@ -77,6 +79,7 @@
 | 
			
		||||
    {
 | 
			
		||||
      "version": "10.20.1",
 | 
			
		||||
      "stable": true,
 | 
			
		||||
      "lts": "Dubnium",
 | 
			
		||||
      "release_url": "https://github.com/actions/node-versions/releases/tag/10.20.1-20200423.27",
 | 
			
		||||
      "files": [
 | 
			
		||||
        {
 | 
			
		||||
@@ -102,6 +105,7 @@
 | 
			
		||||
    {
 | 
			
		||||
      "version": "8.17.0",
 | 
			
		||||
      "stable": true,
 | 
			
		||||
      "lts": "Carbon",
 | 
			
		||||
      "release_url": "https://github.com/actions/node-versions/releases/tag/8.17.0-20200423.26",
 | 
			
		||||
      "files": [
 | 
			
		||||
        {
 | 
			
		||||
@@ -127,6 +131,7 @@
 | 
			
		||||
    {
 | 
			
		||||
      "version": "6.17.1",
 | 
			
		||||
      "stable": true,
 | 
			
		||||
      "lts": "Boron",
 | 
			
		||||
      "release_url": "https://github.com/actions/node-versions/releases/tag/6.17.1-20200423.25",
 | 
			
		||||
      "files": [
 | 
			
		||||
        {
 | 
			
		||||
 
 | 
			
		||||
@@ -134,6 +134,7 @@ describe('setup-node', () => {
 | 
			
		||||
    let match = await tc.findFromManifest('12.16.2', true, versions);
 | 
			
		||||
    expect(match).toBeDefined();
 | 
			
		||||
    expect(match?.version).toBe('12.16.2');
 | 
			
		||||
    expect((match as any).lts).toBe('Erbium')
 | 
			
		||||
  });
 | 
			
		||||
 | 
			
		||||
  it('can find 12 from manifest on linux', async () => {
 | 
			
		||||
@@ -148,6 +149,7 @@ describe('setup-node', () => {
 | 
			
		||||
    let match = await tc.findFromManifest('12.16.2', true, versions);
 | 
			
		||||
    expect(match).toBeDefined();
 | 
			
		||||
    expect(match?.version).toBe('12.16.2');
 | 
			
		||||
    expect((match as any).lts).toBe('Erbium')
 | 
			
		||||
  });
 | 
			
		||||
 | 
			
		||||
  it('can find 10 from manifest on windows', async () => {
 | 
			
		||||
@@ -162,6 +164,7 @@ describe('setup-node', () => {
 | 
			
		||||
    let match = await tc.findFromManifest('10', true, versions);
 | 
			
		||||
    expect(match).toBeDefined();
 | 
			
		||||
    expect(match?.version).toBe('10.20.1');
 | 
			
		||||
    expect((match as any).lts).toBe('Dubnium')
 | 
			
		||||
  });
 | 
			
		||||
 | 
			
		||||
  //--------------------------------------------------
 | 
			
		||||
@@ -217,6 +220,10 @@ describe('setup-node', () => {
 | 
			
		||||
    expect(cnSpy).toHaveBeenCalledWith('::error::' + errMsg + osm.EOL);
 | 
			
		||||
  });
 | 
			
		||||
 | 
			
		||||
  //--------------------------------------------------
 | 
			
		||||
  // Manifest tests
 | 
			
		||||
  //--------------------------------------------------
 | 
			
		||||
 | 
			
		||||
  it('downloads a version from a manifest match', async () => {
 | 
			
		||||
    os.platform = 'linux';
 | 
			
		||||
    os.arch = 'x64';
 | 
			
		||||
@@ -525,4 +532,61 @@ describe('setup-node', () => {
 | 
			
		||||
      expect(cnSpy).toHaveBeenCalledWith(`::add-path::${expPath}${osm.EOL}`);
 | 
			
		||||
    });
 | 
			
		||||
  });
 | 
			
		||||
 | 
			
		||||
  describe('LTS version', () => {
 | 
			
		||||
    it('find latest LTS version and resolve it from local cache (lts/erbium)', async () => {
 | 
			
		||||
      // arrange
 | 
			
		||||
      os.platform = 'linux';
 | 
			
		||||
      os.arch = 'x64';
 | 
			
		||||
 | 
			
		||||
      inputs['node-version'] = 'lts/erbium';
 | 
			
		||||
      inputs.stable = 'true';
 | 
			
		||||
 | 
			
		||||
      const toolPath = path.normalize('/cache/node/12.16.2/x64');
 | 
			
		||||
      findSpy.mockReturnValue(toolPath);
 | 
			
		||||
 | 
			
		||||
      // act
 | 
			
		||||
      await main.run();
 | 
			
		||||
 | 
			
		||||
      // assert
 | 
			
		||||
      expect(logSpy).toHaveBeenCalledWith('Attempt to resolve the latest version from manifest...');
 | 
			
		||||
      expect(warningSpy).toHaveBeenCalledWith('LTS version is provided. For LTS versions `check-latest` will be automatically set to true')
 | 
			
		||||
      expect(dbgSpy).toHaveBeenCalledWith(`LTS alias 'erbium' for Node version 'lts/erbium'`)
 | 
			
		||||
      expect(dbgSpy).toHaveBeenCalledWith(`Found LTS release 'erbium' for Node version 'lts/erbium'`)
 | 
			
		||||
      expect(logSpy).toHaveBeenCalledWith("Resolved as '12.16.2'");
 | 
			
		||||
      expect(logSpy).toHaveBeenCalledWith(`Found in cache @ ${toolPath}`);
 | 
			
		||||
      expect(cnSpy).toHaveBeenCalledWith(`::add-path::${toolPath}/bin${osm.EOL}`);
 | 
			
		||||
    });
 | 
			
		||||
 | 
			
		||||
    it('find latest LTS version and install it from manifest (lts/erbium)', async () => {
 | 
			
		||||
      // arrange
 | 
			
		||||
      os.platform = 'linux';
 | 
			
		||||
      os.arch = 'x64';
 | 
			
		||||
 | 
			
		||||
      inputs['node-version'] = 'lts/erbium';
 | 
			
		||||
      inputs.stable = 'true';
 | 
			
		||||
 | 
			
		||||
      const toolPath = path.normalize('/cache/node/12.16.2/x64');
 | 
			
		||||
      findSpy.mockImplementation(() => '');
 | 
			
		||||
      dlSpy.mockImplementation(async () => '/some/temp/path');
 | 
			
		||||
      exSpy.mockImplementation(async () => '/some/other/temp/path');
 | 
			
		||||
      cacheSpy.mockImplementation(async () => toolPath);
 | 
			
		||||
      const expectedUrl = 'https://github.com/actions/node-versions/releases/download/12.16.2-20200423.28/node-12.16.2-linux-x64.tar.gz';
 | 
			
		||||
 | 
			
		||||
      // act
 | 
			
		||||
      await main.run();
 | 
			
		||||
 | 
			
		||||
      // assert
 | 
			
		||||
      expect(logSpy).toHaveBeenCalledWith('Attempt to resolve the latest version from manifest...');
 | 
			
		||||
      expect(warningSpy).toHaveBeenCalledWith('LTS version is provided. For LTS versions `check-latest` will be automatically set to true')
 | 
			
		||||
      expect(dbgSpy).toHaveBeenCalledWith(`LTS alias 'erbium' for Node version 'lts/erbium'`)
 | 
			
		||||
      expect(dbgSpy).toHaveBeenCalledWith(`Found LTS release 'erbium' for Node version 'lts/erbium'`)
 | 
			
		||||
      expect(logSpy).toHaveBeenCalledWith("Resolved as '12.16.2'");
 | 
			
		||||
      expect(logSpy).toHaveBeenCalledWith("Attempting to download 12.16.2...");
 | 
			
		||||
      expect(logSpy).toHaveBeenCalledWith(`Acquiring 12.16.2 - ${os.arch} from ${expectedUrl}`);
 | 
			
		||||
      expect(logSpy).toHaveBeenCalledWith('Extracting ...');
 | 
			
		||||
      expect(logSpy).toHaveBeenCalledWith('Adding to the cache ...');
 | 
			
		||||
      expect(cnSpy).toHaveBeenCalledWith(`::add-path::${toolPath}/bin${osm.EOL}`);
 | 
			
		||||
    })
 | 
			
		||||
  })
 | 
			
		||||
});
 | 
			
		||||
 
 | 
			
		||||
@@ -34,6 +34,11 @@ export async function getNode(
 | 
			
		||||
  let osPlat: string = os.platform();
 | 
			
		||||
  let osArch: string = translateArchToDistUrl(arch);
 | 
			
		||||
 | 
			
		||||
  if (isLts(versionSpec)) {
 | 
			
		||||
    core.warning('LTS version is provided. For LTS versions `check-latest` will be automatically set to true');
 | 
			
		||||
    checkLatest = true;
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  if (checkLatest) {
 | 
			
		||||
    core.info('Attempt to resolve the latest version from manifest...');
 | 
			
		||||
    const resolvedVersion = await resolveVersionFromManifest(
 | 
			
		||||
@@ -170,6 +175,34 @@ export async function getNode(
 | 
			
		||||
  core.addPath(toolPath);
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
function isLts(versionSpec: string): boolean {
 | 
			
		||||
  return versionSpec.startsWith('lts')
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
function findLtsVersionFromManifest(
 | 
			
		||||
  versionSpec: string,
 | 
			
		||||
  stable: boolean,
 | 
			
		||||
  candidates: Array<tc.IToolRelease & { lts?: string }>
 | 
			
		||||
): string {
 | 
			
		||||
  const alias = versionSpec.split('lts/')[1]?.toLowerCase();
 | 
			
		||||
 | 
			
		||||
  if (!alias) {
 | 
			
		||||
    throw new Error(`Unexpected LTS alias '${alias}' for Node version '${versionSpec}'`);
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  core.debug(`LTS alias '${alias}' for Node version '${versionSpec}'`);
 | 
			
		||||
 | 
			
		||||
  const release = candidates.find(x => x.lts?.toLowerCase() === alias && x.stable === stable);
 | 
			
		||||
 | 
			
		||||
  if (!release) {
 | 
			
		||||
    throw new Error(`Unable to find LTS release '${alias}' for Node version '${versionSpec}'.`);
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  core.debug(`Found LTS release '${alias}' for Node version '${versionSpec}'`);
 | 
			
		||||
 | 
			
		||||
  return release.version.split('.')[0];
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
async function getInfoFromManifest(
 | 
			
		||||
  versionSpec: string,
 | 
			
		||||
  stable: boolean,
 | 
			
		||||
@@ -183,6 +216,11 @@ async function getInfoFromManifest(
 | 
			
		||||
    auth,
 | 
			
		||||
    'main'
 | 
			
		||||
  );
 | 
			
		||||
 | 
			
		||||
  if (isLts(versionSpec)) {
 | 
			
		||||
    versionSpec = findLtsVersionFromManifest(versionSpec, stable, releases);
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  const rel = await tc.findFromManifest(versionSpec, stable, releases, osArch);
 | 
			
		||||
 | 
			
		||||
  if (rel && rel.files.length > 0) {
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user