Add JSON output of go env and some env as strings

Additional outputs are: - GOPATH as `go-path` string - GOMOD as `go-mod` string - GOCACHE as `go-cache` string - GOMODCACHE as `go-mod-cache` string - `go env` as `go-env` JSON
2026-06-23 13:49:36 +08:00 · 2024-07-24 15:00:42 -07:00
13 changed files with 140 additions and 129 deletions
--- a/.github/workflows/outputs.yml
+++ b/.github/workflows/outputs.yml
@@ -0,0 +1,24 @@
+name: Test outputs
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  setup-go-env:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - id: setup-go
+        uses: ./
+      - run: |
+          echo GOPATH=${{ steps.setup-go.outputs.go-path }}
+          echo GOMOD=${{ steps.setup-go.outputs.go-mod }}
+          echo GOMODCACHE=${{ steps.setup-go.outputs.go-mod-cache }}
+          echo GOVERSION=${{ steps.setup-go.outputs.go-version }}
+          echo GOCACHE=${{ steps.setup-go.outputs.go-cache }}
+
+          echo Go environment variables json:
+          jq . <<< '${{ steps.setup-go.outputs.go-env }}'
--- a/.github/workflows/publish-immutable-actions.yml
+++ b/.github/workflows/publish-immutable-actions.yml
@@ -1,20 +0,0 @@
-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@0.0.3
--- a/.github/workflows/release-new-action-version.yml
+++ b/.github/workflows/release-new-action-version.yml
@@ -22,7 +22,7 @@ jobs:
    runs-on: ubuntu-latest
    steps:
      - name: Update the ${{ env.TAG_NAME }} tag
-        uses: actions/publish-action@v0.3.0
+        uses: actions/publish-action@v0.2.2
        with:
          source-tag: ${{ env.TAG_NAME }}
          slack-webhook: ${{ secrets.SLACK_WEBHOOK }}
--- a/.github/workflows/versions.yml
+++ b/.github/workflows/versions.yml
@@ -18,7 +18,7 @@ jobs:
    strategy:
      fail-fast: false
      matrix:
-        os: [ubuntu-latest, windows-latest, macos-latest, macos-13]
+        os: [ubuntu-latest, windows-latest, macos-latest]
    steps:
      - uses: actions/checkout@v4
      - name: Setup Go Stable
@@ -33,7 +33,7 @@ jobs:
    strategy:
      fail-fast: false
      matrix:
-        os: [ubuntu-latest, windows-latest, macos-latest, macos-13]
+        os: [ubuntu-latest, windows-latest, macos-latest]
    steps:
      - uses: actions/checkout@v4
      - name: Setup Go oldStable
@@ -48,14 +48,12 @@ jobs:
    strategy:
      fail-fast: false
      matrix:
-        os: [ubuntu-latest, windows-latest, macos-latest, macos-13]
+        os: [ubuntu-latest, windows-latest, macos-latest]
        version: [stable, oldstable]
        architecture: [x64, x32]
        exclude:
          - os: macos-latest
            architecture: x32
-          - os: macos-13
-            architecture: x32
    steps:
      - uses: actions/checkout@v4
      - name: Setup Go ${{ matrix.version }} ${{ matrix.architecture }}
@@ -72,14 +70,8 @@ jobs:
    strategy:
      fail-fast: false
      matrix:
-        os: [macos-latest, windows-latest, ubuntu-latest, macos-13]
-        go: [1.21.13, 1.22.8, 1.23.2]
-        include:
-          - os: windows-latest
-            go: 1.20.14
-        exclude:
-          - os: windows-latest
-            go: 1.23.2
+        os: [macos-latest, windows-latest, ubuntu-latest]
+        go: [1.20.14, 1.21.10, 1.22.3]
    steps:
      - name: Checkout
        uses: actions/checkout@v4
@@ -98,8 +90,8 @@ jobs:
    strategy:
      fail-fast: false
      matrix:
-        os: [ubuntu-latest, windows-latest, macos-latest, macos-13]
-        go-version: ['1.20', '1.21', '1.22', '1.23']
+        os: [ubuntu-latest, windows-latest, macos-latest]
+        go-version: [1.20.14, 1.21]
    steps:
      - uses: actions/checkout@v4
      - name: Setup Go and check latest
@@ -115,7 +107,7 @@ jobs:
    strategy:
      fail-fast: false
      matrix:
-        os: [ubuntu-latest, windows-latest, macos-latest, macos-13]
+        os: [ubuntu-latest, windows-latest, macos-latest]
    steps:
      - uses: actions/checkout@v4
      - name: Setup Go and check latest
@@ -131,7 +123,7 @@ jobs:
    strategy:
      fail-fast: false
      matrix:
-        os: [ubuntu-latest, windows-latest, macos-latest, macos-13]
+        os: [ubuntu-latest, windows-latest, macos-latest]
    steps:
      - uses: actions/checkout@v4
      - name: Setup Go and check latest
@@ -143,12 +135,13 @@ jobs:
        shell: bash

  setup-versions-from-manifest:
+    name: Setup ${{ matrix.go }} ${{ matrix.os }}
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
-        os: [macos-latest, windows-latest, ubuntu-latest, macos-13]
-        go: [1.20.14, 1.21.10, 1.22.8, 1.23.2]
+        os: [macos-latest, windows-latest, ubuntu-latest]
+        go: [1.20.14, 1.21.10, 1.22.3]
    steps:
      - name: Checkout
        uses: actions/checkout@v4
@@ -163,12 +156,13 @@ jobs:
        shell: bash

  setup-versions-from-dist:
+    name: Setup ${{ matrix.go }} ${{ matrix.os }}
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
-        os: [windows-latest, ubuntu-latest, macos-13]
-        go: [1.11.12]
+        os: [macos-latest, windows-latest, ubuntu-latest]
+        go: [1.20.14, 1.21]
    steps:
      - name: Checkout
        uses: actions/checkout@v4
@@ -187,23 +181,14 @@ jobs:
    strategy:
      fail-fast: false
      matrix:
-        os: [ubuntu-latest, windows-latest, macos-latest, macos-13]
-        go-version: [1.20.14, 1.21, 1.22, 1.23]
-        include:
-          - os: macos-latest
-            architecture: arm64
-          - os: ubuntu-latest
-            architecture: x64
-          - os: windows-latest
-            architecture: x64
-          - os: macos-13
-            architecture: x64
+        os: [ubuntu-latest, windows-latest, macos-latest]
+        go-version: [1.20.14, 1.21]
    steps:
      - uses: actions/checkout@v4
      - name: Setup Go and check latest
        uses: ./
        with:
          go-version: ${{ matrix.go-version }}
-          architecture: ${{ matrix.architecture }}
+          architecture: x64
      - name: Verify Go
        run: go version
--- a/tests/cache-utils.test.ts
+++ b/tests/cache-utils.test.ts
@@ -209,41 +209,3 @@ describe('isCacheFeatureAvailable', () => {
    expect(warningSpy).toHaveBeenCalledWith(warningMessage);
  });
 });
-
-describe('isGhes', () => {
-  const pristineEnv = process.env;
-
-  beforeEach(() => {
-    jest.resetModules();
-    process.env = {...pristineEnv};
-  });
-
-  afterAll(() => {
-    process.env = pristineEnv;
-  });
-
-  it('returns false when the GITHUB_SERVER_URL environment variable is not defined', async () => {
-    delete process.env['GITHUB_SERVER_URL'];
-    expect(cacheUtils.isGhes()).toBeFalsy();
-  });
-
-  it('returns false when the GITHUB_SERVER_URL environment variable is set to github.com', async () => {
-    process.env['GITHUB_SERVER_URL'] = 'https://github.com';
-    expect(cacheUtils.isGhes()).toBeFalsy();
-  });
-
-  it('returns false when the GITHUB_SERVER_URL environment variable is set to a GitHub Enterprise Cloud-style URL', async () => {
-    process.env['GITHUB_SERVER_URL'] = 'https://contoso.ghe.com';
-    expect(cacheUtils.isGhes()).toBeFalsy();
-  });
-
-  it('returns false when the GITHUB_SERVER_URL environment variable has a .localhost suffix', async () => {
-    process.env['GITHUB_SERVER_URL'] = 'https://mock-github.localhost';
-    expect(cacheUtils.isGhes()).toBeFalsy();
-  });
-
-  it('returns true when the GITHUB_SERVER_URL environment variable is set to some other URL', async () => {
-    process.env['GITHUB_SERVER_URL'] = 'https://src.onpremise.fabrikam.com';
-    expect(cacheUtils.isGhes()).toBeTruthy();
-  });
-});
--- a/tests/setup-go.test.ts
+++ b/tests/setup-go.test.ts
@@ -138,6 +138,29 @@ describe('setup-go', () => {
    expect(main.parseGoVersion(goVersionOutput)).toBe('1.16.6');
  });

+  it('can read go env variables', async () => {
+    const goRoot = '/opt/hostedtoolcache/go/1.18.10/x64';
+    const goPath = '/home/runner/go';
+    const goModCache = '/home/runner/go/pkg/mod';
+    const goCache = '/home/runner/.cache/go-build';
+    const goVersion = 'go1.18.10';
+
+    const env = `
+GOROOT="${goRoot}"
+GOPATH="${goPath}"
+GOMODCACHE="${goModCache}"
+GOCACHE="${goCache}"
+GOVERSION="${goVersion}"
+    `;
+    const json = JSON.parse(main.convertEnvStringToJson(env));
+    expect(json).toBeDefined();
+    expect(json['GOROOT']).toBe(goRoot);
+    expect(json['GOPATH']).toBe(goPath);
+    expect(json['GOMODCACHE']).toBe(goModCache);
+    expect(json['GOCACHE']).toBe(goCache);
+    expect(json['GOVERSION']).toBe(goVersion);
+  });
+
  it('can find 1.9.7 from manifest on osx', async () => {
    os.platform = 'darwin';
    os.arch = 'x64';
--- a/action.yml
+++ b/action.yml
@@ -22,6 +22,18 @@ inputs:
 outputs:
  go-version:
    description: 'The installed Go version. Useful when given a version range as input.'
+  go-cache:
+    description: 'The GOCACHE environment variable'
+  go-path:
+    description: 'The GOPATH environment variable'
+  go-root:
+    description: 'The GOROOT environment variable'
+  go-mod:
+    description: 'The GOMOD environment variable'
+  go-mod-cache:
+    description: 'The GOMODCACHE environment variable'
+  go-env:
+    description: 'The Go environment variables in JSON format'
  cache-hit:
    description: 'A boolean value to indicate if a cache was hit'
 runs:
--- a/dist/cache-save/index.js
+++ b/dist/cache-save/index.js
@@ -81175,11 +81175,7 @@ const getCacheDirectoryPath = (packageManagerInfo) => __awaiter(void 0, void 0,
 exports.getCacheDirectoryPath = getCacheDirectoryPath;
 function isGhes() {
    const ghUrl = new URL(process.env['GITHUB_SERVER_URL'] || 'https://github.com');
-    const hostname = ghUrl.hostname.trimEnd().toUpperCase();
-    const isGitHubHost = hostname === 'GITHUB.COM';
-    const isGitHubEnterpriseCloudHost = hostname.endsWith('.GHE.COM');
-    const isLocalHost = hostname.endsWith('.LOCALHOST');
-    return !isGitHubHost && !isGitHubEnterpriseCloudHost && !isLocalHost;
+    return ghUrl.hostname.toUpperCase() !== 'GITHUB.COM';
 }
 exports.isGhes = isGhes;
 function isCacheFeatureAvailable() {
--- a/dist/setup/index.js
+++ b/dist/setup/index.js
@@ -88045,7 +88045,6 @@ const cache_utils_1 = __nccwpck_require__(1678);
 const restoreCache = (versionSpec, packageManager, cacheDependencyPath) => __awaiter(void 0, void 0, void 0, function* () {
    const packageManagerInfo = yield (0, cache_utils_1.getPackageManagerInfo)(packageManager);
    const platform = process.env.RUNNER_OS;
-    const arch = process.arch;
    const cachePaths = yield (0, cache_utils_1.getCacheDirectoryPath)(packageManagerInfo);
    const dependencyFilePath = cacheDependencyPath
        ? cacheDependencyPath
@@ -88055,7 +88054,7 @@ const restoreCache = (versionSpec, packageManager, cacheDependencyPath) => __awa
        throw new Error('Some specified paths were not resolved, unable to cache dependencies.');
    }
    const linuxVersion = process.env.RUNNER_OS === 'Linux' ? `${process.env.ImageOS}-` : '';
-    const primaryKey = `setup-go-${platform}-${arch}-${linuxVersion}go-${versionSpec}-${fileHash}`;
+    const primaryKey = `setup-go-${platform}-${linuxVersion}go-${versionSpec}-${fileHash}`;
    core.debug(`primary key is ${primaryKey}`);
    core.saveState(constants_1.State.CachePrimaryKey, primaryKey);
    const cacheKey = yield cache.restoreCache(cachePaths, primaryKey);
@@ -88165,11 +88164,7 @@ const getCacheDirectoryPath = (packageManagerInfo) => __awaiter(void 0, void 0,
 exports.getCacheDirectoryPath = getCacheDirectoryPath;
 function isGhes() {
    const ghUrl = new URL(process.env['GITHUB_SERVER_URL'] || 'https://github.com');
-    const hostname = ghUrl.hostname.trimEnd().toUpperCase();
-    const isGitHubHost = hostname === 'GITHUB.COM';
-    const isGitHubEnterpriseCloudHost = hostname.endsWith('.GHE.COM');
-    const isLocalHost = hostname.endsWith('.LOCALHOST');
-    return !isGitHubHost && !isGitHubEnterpriseCloudHost && !isLocalHost;
+    return ghUrl.hostname.toUpperCase() !== 'GITHUB.COM';
 }
 exports.isGhes = isGhes;
 function isCacheFeatureAvailable() {
@@ -88639,7 +88634,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
    return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.parseGoVersion = exports.addBinToPath = exports.run = void 0;
+exports.convertEnvStringToJson = exports.parseGoVersion = exports.addBinToPath = exports.run = void 0;
 const core = __importStar(__nccwpck_require__(2186));
 const io = __importStar(__nccwpck_require__(7436));
 const installer = __importStar(__nccwpck_require__(2574));
@@ -88687,11 +88682,19 @@ function run() {
            core.debug(`add bin ${added}`);
            const goPath = yield io.which('go');
            const goVersion = (child_process_1.default.execSync(`${goPath} version`) || '').toString();
+            const goEnv = (child_process_1.default.execSync(`${goPath} env`) || '').toString();
+            const goEnvJson = JSON.parse(convertEnvStringToJson(goEnv));
+            const parsedGoVersion = parseGoVersion(goVersion);
+            // Go versions less that 1.16 do not have the GOVERSION environment variable
+            if (semver.lt(parsedGoVersion, '1.16.0')) {
+                goEnvJson['GOVERSION'] = 'go' + parsedGoVersion;
+            }
+            core.info(goVersion);
            if (cache && (0, cache_utils_1.isCacheFeatureAvailable)()) {
                const packageManager = 'default';
                const cacheDependencyPath = core.getInput('cache-dependency-path');
                try {
-                    yield (0, cache_restore_1.restoreCache)(parseGoVersion(goVersion), packageManager, cacheDependencyPath);
+                    yield (0, cache_restore_1.restoreCache)(parsedGoVersion, packageManager, cacheDependencyPath);
                }
                catch (error) {
                    core.warning(`Restore cache failed: ${error.message}`);
@@ -88700,11 +88703,12 @@ function run() {
            // add problem matchers
            const matchersPath = path_1.default.join(__dirname, '../..', 'matchers.json');
            core.info(`##[add-matcher]${matchersPath}`);
-            // output the version actually being used
-            core.info(goVersion);
-            core.setOutput('go-version', parseGoVersion(goVersion));
+            core.setOutput('go-version', parsedGoVersion);
+            core.setOutput('go-path', goEnvJson['GOPATH']);
+            core.setOutput('go-cache', goEnvJson['GOCACHE']);
+            core.setOutput('go-mod-cache', goEnvJson['GOMODCACHE']);
+            core.setOutput('go-env', goEnvJson);
            core.startGroup('go env');
-            const goEnv = (child_process_1.default.execSync(`${goPath} env`) || '').toString();
            core.info(goEnv);
            core.endGroup();
        }
@@ -88752,6 +88756,16 @@ function parseGoVersion(versionString) {
    return versionString.split(' ')[2].slice('go'.length);
 }
 exports.parseGoVersion = parseGoVersion;
+function convertEnvStringToJson(envString) {
+    const envArray = envString.split('\n');
+    const envObject = {};
+    envArray.forEach(envVar => {
+        const [key, value] = envVar.split(/=(?=")/);
+        envObject[key] = value === null || value === void 0 ? void 0 : value.replace(/"/g, '');
+    });
+    return JSON.stringify(envObject);
+}
+exports.convertEnvStringToJson = convertEnvStringToJson;
 function resolveVersionInput() {
    let version = core.getInput('go-version');
    const versionFilePath = core.getInput('go-version-file');
--- a/package-lock.json
+++ b/package-lock.json
@@ -4559,12 +4559,12 @@
      }
    },
    "node_modules/micromatch": {
-      "version": "4.0.8",
-      "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.8.tgz",
-      "integrity": "sha512-PXwfBhYu0hBCPw8Dn0E+WDYb7af3dSLVWKi3HGv84IdF4TyFoC0ysxFd0Goxw7nSv4T/PzEJQxsYsEiFCKo2BA==",
+      "version": "4.0.5",
+      "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.5.tgz",
+      "integrity": "sha512-DMy+ERcEW2q8Z2Po+WNXuw3c5YaUSFjAO5GsJqfEl7UjvtIuFKO6ZrKvcItdy98dwFI2N1tg3zNIdKaQT+aNdA==",
      "dev": true,
      "dependencies": {
-        "braces": "^3.0.3",
+        "braces": "^3.0.2",
        "picomatch": "^2.3.1"
      },
      "engines": {
--- a/src/cache-restore.ts
+++ b/src/cache-restore.ts
@@ -15,7 +15,6 @@ export const restoreCache = async (
 ) => {
  const packageManagerInfo = await getPackageManagerInfo(packageManager);
  const platform = process.env.RUNNER_OS;
-  const arch = process.arch;

  const cachePaths = await getCacheDirectoryPath(packageManagerInfo);

@@ -32,7 +31,7 @@ export const restoreCache = async (

  const linuxVersion =
    process.env.RUNNER_OS === 'Linux' ? `${process.env.ImageOS}-` : '';
-  const primaryKey = `setup-go-${platform}-${arch}-${linuxVersion}go-${versionSpec}-${fileHash}`;
+  const primaryKey = `setup-go-${platform}-${linuxVersion}go-${versionSpec}-${fileHash}`;
  core.debug(`primary key is ${primaryKey}`);

  core.saveState(State.CachePrimaryKey, primaryKey);
--- a/src/cache-utils.ts
+++ b/src/cache-utils.ts
@@ -63,13 +63,7 @@ export function isGhes(): boolean {
  const ghUrl = new URL(
    process.env['GITHUB_SERVER_URL'] || 'https://github.com'
  );
-
-  const hostname = ghUrl.hostname.trimEnd().toUpperCase();
-  const isGitHubHost = hostname === 'GITHUB.COM';
-  const isGitHubEnterpriseCloudHost = hostname.endsWith('.GHE.COM');
-  const isLocalHost = hostname.endsWith('.LOCALHOST');
-
-  return !isGitHubHost && !isGitHubEnterpriseCloudHost && !isLocalHost;
+  return ghUrl.hostname.toUpperCase() !== 'GITHUB.COM';
 }

 export function isCacheFeatureAvailable(): boolean {
--- a/src/main.ts
+++ b/src/main.ts
@@ -63,13 +63,23 @@ export async function run() {

    const goPath = await io.which('go');
    const goVersion = (cp.execSync(`${goPath} version`) || '').toString();
+    const goEnv = (cp.execSync(`${goPath} env`) || '').toString();
+    const goEnvJson = JSON.parse(convertEnvStringToJson(goEnv));
+    const parsedGoVersion = parseGoVersion(goVersion);
+
+    // Go versions less that 1.16 do not have the GOVERSION environment variable
+    if (semver.lt(parsedGoVersion, '1.16.0')) {
+      goEnvJson['GOVERSION'] = 'go' + parsedGoVersion;
+    }
+
+    core.info(goVersion);

    if (cache && isCacheFeatureAvailable()) {
      const packageManager = 'default';
      const cacheDependencyPath = core.getInput('cache-dependency-path');
      try {
        await restoreCache(
-          parseGoVersion(goVersion),
+          parsedGoVersion,
          packageManager,
          cacheDependencyPath
        );
@@ -82,13 +92,13 @@ export async function run() {
    const matchersPath = path.join(__dirname, '../..', 'matchers.json');
    core.info(`##[add-matcher]${matchersPath}`);

-    // output the version actually being used
-    core.info(goVersion);
-
-    core.setOutput('go-version', parseGoVersion(goVersion));
+    core.setOutput('go-version', parsedGoVersion);
+    core.setOutput('go-path', goEnvJson['GOPATH']);
+    core.setOutput('go-cache', goEnvJson['GOCACHE']);
+    core.setOutput('go-mod-cache', goEnvJson['GOMODCACHE']);
+    core.setOutput('go-env', goEnvJson);

    core.startGroup('go env');
-    const goEnv = (cp.execSync(`${goPath} env`) || '').toString();
    core.info(goEnv);
    core.endGroup();
  } catch (error) {
@@ -135,6 +145,18 @@ export function parseGoVersion(versionString: string): string {
  return versionString.split(' ')[2].slice('go'.length);
 }

+export function convertEnvStringToJson(envString: string): string {
+  const envArray = envString.split('\n');
+  const envObject: {[key: string]: string} = {};
+
+  envArray.forEach(envVar => {
+    const [key, value] = envVar.split(/=(?=")/);
+    envObject[key] = value?.replace(/"/g, '');
+  });
+
+  return JSON.stringify(envObject);
+}
+
 function resolveVersionInput(): string {
  let version = core.getInput('go-version');
  const versionFilePath = core.getInput('go-version-file');