V4 - Add workflow file for publishing releases to immutable action package (#583)

* Add Publish Immutable Action to V4

* file name update

.eslintrc.js

@@ -7,7 +7,7 @@ module.exports = {
     'eslint-config-prettier'
   ],
   parser: '@typescript-eslint/parser',
-  plugins: ['@typescript-eslint', 'eslint-plugin-jest'],
+  plugins: ['@typescript-eslint', 'eslint-plugin-node', 'eslint-plugin-jest'],
   rules: {
     '@typescript-eslint/no-require-imports': 'error',
     '@typescript-eslint/no-non-null-assertion': 'off',
@@ -28,7 +28,8 @@ module.exports = {
       }
     ],
     'no-control-regex': 'off',
-    'no-constant-condition': ['error', {checkLoops: false}]
+    'no-constant-condition': ['error', {checkLoops: false}],
+    'node/no-extraneous-import': 'error'
   },
   overrides: [
     {

.github/workflows/publish-immutable-action.yml

@@ -0,0 +1,20 @@
+name: 'Publish Immutable Action Version'
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      id-token: write
+      packages: write
+
+    steps:
+      - name: Checking out
+        uses: actions/checkout@v4
+      - name: Publish
+        id: publish
+        uses: actions/publish-immutable-action@v0.0.4

.github/workflows/versions.yml

@@ -107,7 +107,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [ubuntu-latest, windows-latest, macos-latest]
+        os: [ubuntu-latest, windows-latest, macos-13]
     steps:
       - uses: actions/checkout@v3
       - name: Setup Go and check latest
@@ -140,7 +140,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [macos-latest, windows-latest, ubuntu-latest]
+        os: [macos-13, windows-latest, ubuntu-latest]
         go: [1.12.16, 1.13.11, 1.14.3]
     steps:
       - name: Checkout
@@ -161,8 +161,11 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [macos-latest, windows-latest, ubuntu-latest]
-        go: [1.9, 1.8.6]
+        os: [macos-13, windows-latest, ubuntu-latest]
+        go: [1.11.12, 1.8.6]
+        exclude:
+          - os: macos-13
+            go: 1.8.6
     steps:
       - name: Checkout
         uses: actions/checkout@v3

.github/workflows/windows-validation.yml

@@ -0,0 +1,114 @@
+name: Validate Windows installation
+
+on:
+  push:
+    branches:
+      - main
+    paths-ignore:
+      - '**.md'
+  pull_request:
+    paths-ignore:
+      - '**.md'
+
+jobs:
+  create-link-if-not-default:
+    runs-on: windows-latest
+    name: 'Validate if symlink is created'
+    strategy:
+      matrix:
+        cache: [false, true]
+        go: [1.20.1]
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: 'Setup ${{ matrix.cache }}, cache: ${{ matrix.go }}'
+        uses: ./
+        with:
+          go-version: ${{ matrix.go }}
+          cache: ${{ matrix.cache }}
+
+      - name: 'Drive C: should have zero size link'
+        run: |
+          du -m -s 'C:\hostedtoolcache\windows\go\${{ matrix.go }}\x64'
+          # make sure drive c: contains only a link
+          size=$(du -m -s 'C:\hostedtoolcache\windows\go\${{ matrix.go }}\x64'|cut -f1 -d$'\t')
+          if [ $size -ne 0 ];then
+            echo 'Size of the link created on drive c: must be 0'
+            exit 1
+          fi
+        shell: bash
+
+      # Drive D: is small, take care the action does not eat up the space
+      - name: 'Drive D: space usage should be below 1G'
+        run: |
+          du -m -s 'D:\hostedtoolcache\windows\go\${{ matrix.go }}\x64'
+          size=$(du -m -s 'D:\hostedtoolcache\windows\go\${{ matrix.go }}\x64'|cut -f1 -d$'\t')
+          # make sure archive does not take lot of space
+          if [ $size -gt 999 ];then
+            echo 'Size of installed on drive d: go is too big';
+            exit 1
+          fi
+        shell: bash
+
+      # make sure the Go installation has not been changed to the end user
+      - name: Test paths and environments
+        run: |
+          echo $PATH
+          which go
+          go version
+          go env
+          if [ $(which go) != '/c/hostedtoolcache/windows/go/${{ matrix.go }}/x64/bin/go' ];then
+            echo 'which go should return "/c/hostedtoolcache/windows/go/${{ matrix.go }}/x64/bin/go"'
+            exit 1
+          fi
+          if [ $(go env GOROOT) != 'C:\hostedtoolcache\windows\go\${{ matrix.go }}\x64' ];then 
+            echo 'go env GOROOT should return "C:\hostedtoolcache\windows\go\${{ matrix.go }}\x64"'
+            exit 1
+          fi
+        shell: bash
+
+  find-default-go:
+    name: 'Find default go version'
+    runs-on: windows-latest
+    outputs:
+      version: ${{ steps.goversion.outputs.version }}
+    steps:
+      - run: |
+          version=`go env GOVERSION|sed s/^go//`
+          echo "default go version: $version"
+          echo "version=$version" >> "$GITHUB_OUTPUT"
+        id: goversion
+        shell: bash
+
+  dont-create-link-if-default:
+    name: 'Validate if symlink is not created for default go'
+    runs-on: windows-latest
+    needs: find-default-go
+    strategy:
+      matrix:
+        cache: [false, true]
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: 'Setup default go, cache: ${{ matrix.cache }}'
+        uses: ./
+        with:
+          go-version: ${{ needs.find-default-go.outputs.version }}
+          cache: ${{ matrix.cache }}
+
+      - name: 'Drive C: should have Go installation, cache: ${{ matrix.cache}}'
+        run: |
+          size=$(du -m -s 'C:\hostedtoolcache\windows\go\${{ needs.find-default-go.outputs.version }}\x64'|cut -f1 -d$'\t')
+          if [ $size -eq 0 ];then
+            echo 'Size of the hosted go installed on drive c: must be above zero'
+            exit 1
+          fi
+        shell: bash
+
+      - name: 'Drive D: should not have Go installation, cache: ${{ matrix.cache}}'
+        run: |
+          if [ -e 'D:\hostedtoolcache\windows\go\${{ needs.find-default-go.outputs.version }}\x64' ];then
+            echo 'D:\hostedtoolcache\windows\go\${{ needs.find-default-go.outputs.version }}\x64 should not exist for hosted version of go';
+            exit 1
+          fi
+        shell: bash

README.md

@@ -43,7 +43,7 @@ Matching by [semver spec](https://github.com/npm/node-semver):
 ```yaml
 steps:
   - uses: actions/checkout@v3
-  - uses: actions/setup-go@v3
+  - uses: actions/setup-go@v4
     with:
       go-version: '^1.13.1' # The Go version to download (if necessary) and use.
   - run: go version
@@ -52,18 +52,25 @@ steps:
 ```yaml
 steps:
   - uses: actions/checkout@v3
-  - uses: actions/setup-go@v3
+  - uses: actions/setup-go@v4
     with:
       go-version: '>=1.17.0'
   - run: go version
 ```
 
+> **Note**: Due to the peculiarities of YAML parsing, it is recommended to wrap the version in single quotation marks:
+> 
+> ```yaml
+>   go-version: '1.20'
+>  ```
+>  
+> The recommendation is based on the YAML parser's behavior, which interprets non-wrapped values as numbers and, in the case of version 1.20, trims it down to 1.2, which may not be very obvious.
 Matching an unstable pre-release:
 
 ```yaml
 steps:
   - uses: actions/checkout@v3
-  - uses: actions/setup-go@v3
+  - uses: actions/setup-go@v4
     with:
       go-version: '1.18.0-rc.1' # The Go version to download (if necessary) and use.
   - run: go version
@@ -72,7 +79,7 @@ steps:
 ```yaml
 steps:
   - uses: actions/checkout@v3
-  - uses: actions/setup-go@v3
+  - uses: actions/setup-go@v4
     with:
       go-version: '1.16.0-beta.1' # The Go version to download (if necessary) and use.
   - run: go version
@@ -87,7 +94,7 @@ See [action.yml](action.yml)
 ```yaml
 steps:
   - uses: actions/checkout@v3
-  - uses: actions/setup-go@v3
+  - uses: actions/setup-go@v4
     with:
       go-version: '1.16.1' # The Go version to download (if necessary) and use.
   - run: go run hello.go
@@ -108,7 +115,7 @@ want the most up-to-date Go version to always be used.
 ```yaml
 steps:
   - uses: actions/checkout@v3
-  - uses: actions/setup-go@v3
+  - uses: actions/setup-go@v4
     with:
       go-version: '1.14'
       check-latest: true
@@ -129,7 +136,7 @@ set to `true`
 ```yaml
 steps:
   - uses: actions/checkout@v3
-  - uses: actions/setup-go@v3
+  - uses: actions/setup-go@v4
     with:
       go-version: 'stable'
   - run: go run hello.go
@@ -138,7 +145,7 @@ steps:
 ```yaml
 steps:
   - uses: actions/checkout@v3
-  - uses: actions/setup-go@v3
+  - uses: actions/setup-go@v4
     with:
       go-version: 'oldstable'
   - run: go run hello.go
@@ -161,7 +168,7 @@ If some problem that prevents success caching happens then the action issues the
 ```yaml
 steps:
   - uses: actions/checkout@v3
-  - uses: actions/setup-go@v3
+  - uses: actions/setup-go@v4
     with:
       go-version: '1.17'
       check-latest: true
@@ -183,7 +190,7 @@ If both the `go-version` and the `go-version-file` inputs are provided then the
 ```yaml
 steps:
   - uses: actions/checkout@v3
-  - uses: actions/setup-go@v3
+  - uses: actions/setup-go@v4
     with:
       go-version-file: 'path/to/go.mod'
   - run: go version
@@ -202,7 +209,7 @@ jobs:
     steps:
       - uses: actions/checkout@v3
       - name: Setup go
-        uses: actions/setup-go@v3
+        uses: actions/setup-go@v4
         with:
           go-version: ${{ matrix.go }}
       - run: go run hello.go
@@ -234,10 +241,10 @@ can [generate a personal access token on github.com](https://github.com/settings
 input for the action:
 
 ```yaml
-uses: actions/setup-go@v3
+uses: actions/setup-go@v4
 with:
   token: ${{ secrets.GH_DOTCOM_TOKEN }}
-  go-version: 1.18
+  go-version: '1.18'
 ```
 
 If the runner is not able to access github.com, any Go versions requested during a workflow run must come from the

__tests__/setup-go.test.ts

@@ -3,7 +3,7 @@ import * as io from '@actions/io';
 import * as tc from '@actions/tool-cache';
 import fs from 'fs';
 import cp from 'child_process';
-import osm from 'os';
+import osm, {type} from 'os';
 import path from 'path';
 import * as main from '../src/main';
 import * as im from '../src/installer';
@@ -16,6 +16,8 @@ const matcherRegExp = new RegExp(matcherPattern.regexp);
 const win32Join = path.win32.join;
 const posixJoin = path.posix.join;
 
+jest.setTimeout(10000);
+
 describe('setup-go', () => {
   let inputs = {} as any;
   let os = {} as any;
@@ -39,6 +41,8 @@ describe('setup-go', () => {
   let existsSpy: jest.SpyInstance;
   let readFileSpy: jest.SpyInstance;
   let mkdirpSpy: jest.SpyInstance;
+  let mkdirSpy: jest.SpyInstance;
+  let symlinkSpy: jest.SpyInstance;
   let execSpy: jest.SpyInstance;
   let getManifestSpy: jest.SpyInstance;
   let getAllVersionsSpy: jest.SpyInstance;
@@ -92,6 +96,11 @@ describe('setup-go', () => {
     readFileSpy = jest.spyOn(fs, 'readFileSync');
     mkdirpSpy = jest.spyOn(io, 'mkdirP');
 
+    // fs
+    mkdirSpy = jest.spyOn(fs, 'mkdir');
+    symlinkSpy = jest.spyOn(fs, 'symlinkSync');
+    symlinkSpy.mockImplementation(() => {});
+
     // gets
     getManifestSpy.mockImplementation(() => <tc.IToolRelease[]>goTestManifest);
 

__tests__/windows-toolcache.test.ts

@@ -0,0 +1,62 @@
+import fs from 'fs';
+import * as io from '@actions/io';
+import * as tc from '@actions/tool-cache';
+import path from 'path';
+
+describe('Windows performance workaround', () => {
+  let mkdirSpy: jest.SpyInstance;
+  let symlinkSpy: jest.SpyInstance;
+  let statSpy: jest.SpyInstance;
+  let readdirSpy: jest.SpyInstance;
+  let writeFileSpy: jest.SpyInstance;
+  let rmRFSpy: jest.SpyInstance;
+  let mkdirPSpy: jest.SpyInstance;
+  let cpSpy: jest.SpyInstance;
+
+  let runnerToolCache: string | undefined;
+  beforeEach(() => {
+    mkdirSpy = jest.spyOn(fs, 'mkdir');
+    symlinkSpy = jest.spyOn(fs, 'symlinkSync');
+    statSpy = jest.spyOn(fs, 'statSync');
+    readdirSpy = jest.spyOn(fs, 'readdirSync');
+    writeFileSpy = jest.spyOn(fs, 'writeFileSync');
+    rmRFSpy = jest.spyOn(io, 'rmRF');
+    mkdirPSpy = jest.spyOn(io, 'mkdirP');
+    cpSpy = jest.spyOn(io, 'cp');
+
+    // default implementations
+    // @ts-ignore - not implement unused methods
+    statSpy.mockImplementation(() => ({
+      isDirectory: () => true
+    }));
+    readdirSpy.mockImplementation(() => []);
+    writeFileSpy.mockImplementation(() => {});
+    mkdirSpy.mockImplementation(() => {});
+    symlinkSpy.mockImplementation(() => {});
+    rmRFSpy.mockImplementation(() => Promise.resolve());
+    mkdirPSpy.mockImplementation(() => Promise.resolve());
+    cpSpy.mockImplementation(() => Promise.resolve());
+
+    runnerToolCache = process.env['RUNNER_TOOL_CACHE'];
+  });
+  afterEach(() => {
+    jest.clearAllMocks();
+    process.env['RUNNER_TOOL_CACHE'] = runnerToolCache;
+  });
+  // cacheWindowsToolkitDir depends on implementation of tc.cacheDir
+  // with the assumption that target dir is passed by RUNNER_TOOL_CACHE environment variable
+  // Make sure the implementation has not been changed
+  it('addExecutablesToCache should depend on env[RUNNER_TOOL_CACHE]', async () => {
+    process.env['RUNNER_TOOL_CACHE'] = '/faked-hostedtoolcache1';
+    const cacheDir1 = await tc.cacheDir('/qzx', 'go', '1.2.3', 'arch');
+    expect(cacheDir1).toBe(
+      path.join('/', 'faked-hostedtoolcache1', 'go', '1.2.3', 'arch')
+    );
+
+    process.env['RUNNER_TOOL_CACHE'] = '/faked-hostedtoolcache2';
+    const cacheDir2 = await tc.cacheDir('/qzx', 'go', '1.2.3', 'arch');
+    expect(cacheDir2).toBe(
+      path.join('/', 'faked-hostedtoolcache2', 'go', '1.2.3', 'arch')
+    );
+  });
+});

action.yml

@@ -3,14 +3,14 @@ description: 'Setup a Go environment and add it to the PATH'
 author: 'GitHub'
 inputs:
   go-version:
-    description: 'The Go version to download (if necessary) and use. Supports semver spec and ranges.'
+    description: 'The Go version to download (if necessary) and use. Supports semver spec and ranges. Be sure to enclose this option in single quotation marks.'
   go-version-file:
     description: 'Path to the go.mod or go.work file.'
   check-latest:
     description: 'Set this option to true if you want the action to always check for the latest available version that satisfies the version spec'
     default: false
   token:
-    description: Used to pull node distributions from go-versions. Since there's a default, this is typically not supplied by the user. When running this action on github.com, the default value is sufficient. When running on GHES, you can pass a personal access token for github.com if you are experiencing rate limiting.
+    description: Used to pull Go distributions from go-versions. Since there's a default, this is typically not supplied by the user. When running this action on github.com, the default value is sufficient. When running on GHES, you can pass a personal access token for github.com if you are experiencing rate limiting.
     default: ${{ github.server_url == 'https://github.com' && github.token || '' }}
   cache:
     description: Used to specify whether caching is needed. Set to true, if you'd like to enable caching.

package.json

@@ -6,10 +6,10 @@
   "main": "lib/setup-go.js",
   "scripts": {
     "build": "tsc && ncc build -o dist/setup src/setup-go.ts && ncc build -o dist/cache-save src/cache-save.ts",
-    "format": "prettier --no-error-on-unmatched-pattern --config ./.prettierrc.js --write **/*.{ts,yml,yaml}",
-    "format-check": "prettier --no-error-on-unmatched-pattern --config ./.prettierrc.js --check **/*.{ts,yml,yaml}",
-    "lint": "eslint --config ./.eslintrc.js **/*.ts",
-    "lint:fix": "eslint --config ./.eslintrc.js **/*.ts --fix",
+    "format": "prettier --no-error-on-unmatched-pattern --config ./.prettierrc.js --write \"**/*.{ts,yml,yaml}\"",
+    "format-check": "prettier --no-error-on-unmatched-pattern --config ./.prettierrc.js --check \"**/*.{ts,yml,yaml}\"",
+    "lint": "eslint --config ./.eslintrc.js \"**/*.ts\"",
+    "lint:fix": "eslint --config ./.eslintrc.js \"**/*.ts\" --fix",
     "test": "jest --coverage",
     "pre-checkin": "npm run format && npm run lint:fix && npm run build && npm test"
   },
@@ -25,14 +25,14 @@
   "author": "GitHub",
   "license": "MIT",
   "dependencies": {
-    "@actions/cache": "^3.0.0",
+    "@actions/cache": "^4.0.3",
     "@actions/core": "^1.10.0",
     "@actions/exec": "^1.1.0",
     "@actions/glob": "^0.2.0",
     "@actions/http-client": "^2.0.1",
     "@actions/io": "^1.0.2",
     "@actions/tool-cache": "^1.5.5",
-    "semver": "^6.1.1"
+    "semver": "^6.3.1"
   },
   "devDependencies": {
     "@types/jest": "^27.0.2",
@@ -44,6 +44,7 @@
     "eslint": "^8.35.0",
     "eslint-config-prettier": "^8.6.0",
     "eslint-plugin-jest": "^27.2.1",
+    "eslint-plugin-node": "^11.1.0",
     "jest": "^27.2.5",
     "jest-circus": "^27.2.5",
     "nock": "^10.0.6",

src/cache-restore.ts

@@ -29,7 +29,9 @@ export const restoreCache = async (
     );
   }
 
-  const primaryKey = `setup-go-${platform}-go-${versionSpec}-${fileHash}`;
+  const linuxVersion =
+    process.env.RUNNER_OS === 'Linux' ? `${process.env.ImageOS}-` : '';
+  const primaryKey = `setup-go-${platform}-${linuxVersion}go-${versionSpec}-${fileHash}`;
   core.debug(`primary key is ${primaryKey}`);
 
   core.saveState(State.CachePrimaryKey, primaryKey);

src/installer.ts

@@ -164,6 +164,64 @@ async function resolveVersionFromManifest(
   }
 }
 
+// for github hosted windows runner handle latency of OS drive
+// by avoiding write operations to C:
+async function cacheWindowsDir(
+  extPath: string,
+  tool: string,
+  version: string,
+  arch: string
+): Promise<string | false> {
+  if (os.platform() !== 'win32') return false;
+
+  // make sure the action runs in the hosted environment
+  if (
+    process.env['RUNNER_ENVIRONMENT'] !== 'github-hosted' &&
+    process.env['AGENT_ISSELFHOSTED'] === '1'
+  )
+    return false;
+
+  const defaultToolCacheRoot = process.env['RUNNER_TOOL_CACHE'];
+  if (!defaultToolCacheRoot) return false;
+
+  if (!fs.existsSync('d:\\') || !fs.existsSync('c:\\')) return false;
+
+  const actualToolCacheRoot = defaultToolCacheRoot
+    .replace('C:', 'D:')
+    .replace('c:', 'd:');
+  // make toolcache root to be on drive d:
+  process.env['RUNNER_TOOL_CACHE'] = actualToolCacheRoot;
+
+  const actualToolCacheDir = await tc.cacheDir(extPath, tool, version, arch);
+
+  // create a link from c: to d:
+  const defaultToolCacheDir = actualToolCacheDir.replace(
+    actualToolCacheRoot,
+    defaultToolCacheRoot
+  );
+  fs.mkdirSync(path.dirname(defaultToolCacheDir), {recursive: true});
+  fs.symlinkSync(actualToolCacheDir, defaultToolCacheDir, 'junction');
+  core.info(`Created link ${defaultToolCacheDir} => ${actualToolCacheDir}`);
+
+  // make outer code to continue using toolcache as if it were installed on c:
+  // restore toolcache root to default drive c:
+  process.env['RUNNER_TOOL_CACHE'] = defaultToolCacheRoot;
+  return defaultToolCacheDir;
+}
+
+async function addExecutablesToToolCache(
+  extPath: string,
+  info: IGoVersionInfo,
+  arch: string
+): Promise<string> {
+  const tool = 'go';
+  const version = makeSemver(info.resolvedVersion);
+  return (
+    (await cacheWindowsDir(extPath, tool, version, arch)) ||
+    (await tc.cacheDir(extPath, tool, version, arch))
+  );
+}
+
 async function installGoVersion(
   info: IGoVersionInfo,
   auth: string | undefined,
@@ -186,14 +244,10 @@ async function installGoVersion(
   }
 
   core.info('Adding to the cache ...');
-  const cachedDir = await tc.cacheDir(
-    extPath,
-    'go',
-    makeSemver(info.resolvedVersion),
-    arch
-  );
-  core.info(`Successfully cached go to ${cachedDir}`);
-  return cachedDir;
+  const toolCacheDir = await addExecutablesToToolCache(extPath, info, arch);
+  core.info(`Successfully cached go to ${toolCacheDir}`);
+
+  return toolCacheDir;
 }
 
 export async function extractGoArchive(archivePath: string): Promise<string> {