Merge pull request #238 from vsafonkin/v-vsafonkin/cache-error-handling

Error handling for cache

.gitattributes

@@ -1 +1,2 @@
+* text=auto
 .licenses/** -diff linguist-generated=true

.github/workflows/check-dist.yml

@@ -21,12 +21,12 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
-      - name: Set Node.js 12.x
+      - name: Set Node.js 16.x
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v3
         with:
-          node-version: 12.x
+          node-version: 16.x
 
       - name: Install dependencies
         run: npm ci
@@ -44,7 +44,7 @@ jobs:
         id: diff
 
       # If index.js was different than expected, upload the expected version as an artifact
-      - uses: actions/upload-artifact@v2
+      - uses: actions/upload-artifact@v3
         if: ${{ failure() && steps.diff.conclusion == 'failure' }}
         with:
           name: dist

.github/workflows/licensed.yml

@@ -13,12 +13,16 @@ jobs:
     runs-on: ubuntu-latest
     name: Check licenses
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
+      - name: Set Node.js 16.x
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16.x
       - run: npm ci
       - name: Install licensed
         run: |
           cd $RUNNER_TEMP
-          curl -Lfs -o licensed.tar.gz https://github.com/github/licensed/releases/download/2.12.2/licensed-2.12.2-linux-x64.tar.gz
+          curl -Lfs -o licensed.tar.gz https://github.com/github/licensed/releases/download/3.4.4/licensed-3.4.4-linux-x64.tar.gz
           sudo tar -xzf licensed.tar.gz
           sudo mv licensed /usr/local/bin/licensed
       - run: licensed status

.github/workflows/versions.yml

@@ -22,7 +22,7 @@ jobs:
         go: [1.12, 1.13, 1.14]
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - name: setup-go ${{ matrix.go }}
         uses: ./
@@ -33,6 +33,39 @@ jobs:
         run: __tests__/verify-go.sh ${{ matrix.go }}
         shell: bash
 
+  check-latest:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+        go-version: [1.16, 1.17]
+    steps:
+      - uses: actions/checkout@v3
+      - name: Setup Go and check latest
+        uses: ./
+        with:
+          go-version: ${{ matrix.go-version }}
+          check-latest: true
+      - name: Verify Go
+        run: go version
+
+  go-version-file:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+    steps:
+      - uses: actions/checkout@v3
+      - name: Setup Go and check latest
+        uses: ./
+        with:
+          go-version-file: __tests__/data/go.mod
+      - name: verify go
+        run: __tests__/verify-go.sh 1.14
+        shell: bash
+
   setup-versions-from-manifest:
     name: Setup ${{ matrix.go }} ${{ matrix.os }}
     runs-on: ${{ matrix.os }}
@@ -43,13 +76,13 @@ jobs:
         go: [1.12.16, 1.13.11, 1.14.3]
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
-      
+
       - name: setup-go ${{ matrix.go }}
         uses: ./
         with:
           go-version: ${{ matrix.go }}
-      
+
       - name: verify go
         run: __tests__/verify-go.sh ${{ matrix.go }}
         shell: bash
@@ -61,10 +94,10 @@ jobs:
       fail-fast: false
       matrix:
         os: [macos-latest, windows-latest, ubuntu-latest]
-        go: [1.7, 1.8.6]
+        go: [1.9, 1.8.6]
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - name: setup-go ${{ matrix.go }}
         uses: ./

.github/workflows/workflow.yml

@@ -17,16 +17,16 @@ jobs:
         operating-system: [ubuntu-latest, windows-latest]
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
-      - name: Setup node 12
+      - name: Setup node 16
-        uses: actions/setup-node@v2
+        uses: actions/setup-node@v3
         with:
-          node-version: 12
+          node-version: 16
           cache: npm
 
-      - name: npm install
+      - name: npm ci
-        run: npm install
+        run: npm ci
 
       - name: Lint
         run: npm run format-check

.licensed.yml

@@ -9,6 +9,7 @@ allowed:
   - mit
   - cc0-1.0
   - unlicense
+  - 0bsd
 
 reviewed:
   npm:

CODEOWNERS

@@ -1 +1 @@
-* @actions/spark
+* @actions/actions-service

CODE_OF_CONDUCT.md

@@ -55,7 +55,7 @@ a project may be further defined and clarified by project maintainers.
 ## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at opensource@github.com. All
+reported by contacting the project team at opensource+actions/setup-go@github.com. All
 complaints will be reviewed and investigated and will result in a response that
 is deemed necessary and appropriate to the circumstances. The project team is
 obligated to maintain confidentiality with regard to the reporter of an incident.
@@ -73,4 +73,4 @@ available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.ht
 [homepage]: https://www.contributor-covenant.org
 
 For answers to common questions about this code of conduct, see
-https://www.contributor-covenant.org/faq
+https://www.contributor-covenant.org/faq

README.md

@@ -1,44 +1,64 @@
 # setup-go
 
-<p align="left">
+[![build-test](https://github.com/actions/setup-go/actions/workflows/workflow.yml/badge.svg)](https://github.com/actions/setup-go/actions/workflows/workflow.yml)
-  <a href="https://github.com/actions/setup-go/actions"><img alt="GitHub Actions status" src="https://github.com/actions/setup-go/workflows/build-test/badge.svg"></a>
+[![Validate 'setup-go'](https://github.com/actions/setup-go/actions/workflows/versions.yml/badge.svg)](https://github.com/actions/setup-go/actions/workflows/versions.yml)
-
-  <a href="https://github.com/actions/setup-go/actions"><img alt="versions status" src="https://github.com/actions/setup-go/workflows/go-versions/badge.svg"></a>  
-</p>
 
 This action sets up a go environment for use in actions by:
 
-- optionally downloading and caching a version of Go by version and adding to PATH
+- Optionally downloading and caching a version of Go by version and adding to `PATH`.
-- registering problem matchers for error output
+- Registering problem matchers for error output.
 
-# V2
+# V3
 
-The V2 offers:
+The V3 edition of the action offers:
-- Adds GOBIN to the PATH
+
-- Proxy Support
+- Adds `GOBIN` to the `PATH`
-- stable input 
+- Proxy support
+- Check latest version
+- Caching packages dependencies
 - Bug Fixes (including issues around version matching and semver)
 
-It will first check the local cache for a version match. If version is not found locally, It will pull it from `main` branch of [go-versions](https://github.com/actions/go-versions/blob/main/versions-manifest.json) repository and on miss or failure, it will fall back to the previous behavior of download directly from [go dist](https://storage.googleapis.com/golang).
+The action will first check the local cache for a version match. If a version is not found locally, it will pull it from the `main` branch of the [go-versions](https://github.com/actions/go-versions/blob/main/versions-manifest.json) repository. On miss or failure, it will fall back to downloading directly from [go dist](https://storage.googleapis.com/golang). To change the default behavior, please use the [check-latest input](#check-latest-version).
+
+**Note:** The `setup-go` action uses executable binaries which are built by Golang side. The action does not build golang from source code.
 
 Matching by [semver spec](https://github.com/npm/node-semver):
+
 ```yaml
 steps:
-  - uses: actions/checkout@v2
+  - uses: actions/checkout@v3
-  - uses: actions/setup-go@v2
+  - uses: actions/setup-go@v3
     with:
       go-version: '^1.13.1' # The Go version to download (if necessary) and use.
   - run: go version
 ```
 
-Matching an unstable pre-release:
 ```yaml
 steps:
-  - uses: actions/checkout@v2
+  - uses: actions/checkout@v3
-  - uses: actions/setup-go@v2
+  - uses: actions/setup-go@v3
     with:
-      stable: 'false'
+      go-version: '>=1.17.0'
-      go-version: '1.14.0-rc1' # The Go version to download (if necessary) and use.
+  - run: go version
+```
+
+Matching an unstable pre-release:
+
+```yaml
+steps:
+  - uses: actions/checkout@v3
+  - uses: actions/setup-go@v3
+    with:
+      go-version: '1.18.0-rc.1' # The Go version to download (if necessary) and use.
+  - run: go version
+```
+
+```yaml
+steps:
+  - uses: actions/checkout@v3
+  - uses: actions/setup-go@v3
+    with:
+      go-version: '1.16.0-beta.1' # The Go version to download (if necessary) and use.
   - run: go version
 ```
 
@@ -46,17 +66,83 @@ steps:
 
 See [action.yml](action.yml)
 
-Basic:
+## Basic
+
 ```yaml
 steps:
-  - uses: actions/checkout@master
+  - uses: actions/checkout@v3
-  - uses: actions/setup-go@v2
+  - uses: actions/setup-go@v3
     with:
-      go-version: '1.9.3' # The Go version to download (if necessary) and use.
+      go-version: '1.16.1' # The Go version to download (if necessary) and use.
   - run: go run hello.go
 ```
 
-Matrix Testing:
+
+## Check latest version
+
+The `check-latest` flag defaults to `false`. Use the default or set `check-latest` to `false` if you prefer stability and if you want to ensure a specific Go version is always used.
+
+If `check-latest` is set to `true`, the action first checks if the cached version is the latest one. If the locally cached version is not the most up-to-date, a Go version will then be downloaded. Set `check-latest` to `true` if you want the most up-to-date Go version to always be used.
+
+> Setting `check-latest` to `true` has performance implications as downloading Go versions is slower than using cached versions.
+
+```yaml
+steps:
+  - uses: actions/checkout@v3
+  - uses: actions/setup-go@v3
+    with:
+      go-version: '1.14'
+      check-latest: true
+  - run: go run hello.go
+```
+## Caching dependency files and build outputs:
+
+The action has a built-in functionality for caching and restoring go modules and build outputs. It uses [actions/cache](https://github.com/actions/cache) under the hood but requires less configuration settings. The `cache` input is optional, and caching is turned off by default.
+
+The action defaults to search for the dependency file - go.sum in the repository root, and uses its hash as a part of the cache key. Use `cache-dependency-path` input for cases when multiple dependency files are used, or they are located in different subdirectories.
+
+**Caching without specifying dependency file path**
+```yaml
+steps:
+  - uses: actions/checkout@v3
+  - uses: actions/setup-go@v3
+    with:
+      go-version: '1.17'
+      check-latest: true
+      cache: true
+  - run: go run hello.go
+```
+
+**Caching in monorepos**
+```yaml
+steps:
+  - uses: actions/checkout@v3
+  - uses: actions/setup-go@v3
+    with:
+      go-version: '1.17'
+      check-latest: true
+      cache: true
+      cache-dependency-path: subdir/go.sum
+  - run: go run hello.go
+  ```
+## Getting go version from the go.mod file
+
+The `go-version-file` input accepts a path to a `go.mod` file containing the version of Go to be used by a project. As the `go.mod` file contains only major and minor (e.g. 1.18) tags, the action will search for the latest available patch version sequentially in the runner's directory with the cached tools, in the [version-manifest.json](https://github.com/actions/go-versions/blob/main/versions-manifest.json) file or at the go servers.
+
+If both the `go-version` and the `go-version-file` inputs are provided then the `go-version` input is used.
+> The action will search for the `go.mod` file relative to the repository root
+
+```yaml
+steps:
+- uses: actions/checkout@v3
+- uses: actions/setup-go@v3
+  with:
+    go-version-file: 'path/to/go.mod'
+- run: go version
+```
+
+## Matrix testing
+
 ```yaml
 jobs:
   build:
@@ -66,20 +152,22 @@ jobs:
         go: [ '1.14', '1.13' ]
     name: Go ${{ matrix.go }} sample
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Setup go
-        uses: actions/setup-go@v2
+        uses: actions/setup-go@v3
         with:
           go-version: ${{ matrix.go }}
       - run: go run hello.go
 ```
 
 ### Supported version syntax
+
 The `go-version` input supports the following syntax:
 
-Specific versions: `1.15`, `1.16.1`, `1.17.0-rc2`, `1.16.0-beta1`  
+- Specific versions: `1.15`, `1.16.1`, `1.17.0-rc.2`, `1.16.0-beta.1`
-SemVer's version range syntax: `^1.13.1`  
+- SemVer's version range syntax: `^1.13.1`, `>=1.18.0-rc.1`
-For more information about semantic versioning please refer [semver](https://github.com/npm/node-semver) documentation
+
+For more information about semantic versioning, please refer to [semver](https://github.com/npm/node-semver) documentation.
 
 # License
 
@@ -87,8 +175,8 @@ The scripts and documentation in this project are released under the [MIT Licens
 
 # Contributions
 
-Contributions are welcome!  See [Contributor's Guide](docs/contributors.md)
+Contributions are welcome! See [Contributor's Guide](docs/contributors.md)
 
 ## Code of Conduct
 
-:wave: Be nice.  See [our code of conduct](CONDUCT)
+:wave: Be nice. See [our code of conduct](CONDUCT)

__tests__/cache-restore.test.ts

@@ -0,0 +1,86 @@
+import * as cache from '@actions/cache';
+import * as core from '@actions/core';
+import * as glob from '@actions/glob';
+
+import * as cacheRestore from '../src/cache-restore';
+import * as cacheUtils from '../src/cache-utils';
+import {PackageManagerInfo} from '../src/package-managers';
+
+describe('restoreCache', () => {
+  //Arrange
+  let hashFilesSpy = jest.spyOn(glob, 'hashFiles');
+  let getCacheDirectoryPathSpy = jest.spyOn(
+    cacheUtils,
+    'getCacheDirectoryPath'
+  );
+  let restoreCacheSpy = jest.spyOn(cache, 'restoreCache');
+  let infoSpy = jest.spyOn(core, 'info');
+  let setOutputSpy = jest.spyOn(core, 'setOutput');
+
+  const packageManager = 'default';
+  const cacheDependencyPath = 'path';
+
+  beforeEach(() => {
+    getCacheDirectoryPathSpy.mockImplementation(
+      (PackageManager: PackageManagerInfo) => {
+        return new Promise<string[]>(resolve => {
+          resolve(['cache_directory_path', 'cache_directory_path']);
+        });
+      }
+    );
+  });
+
+  it('should throw if dependency file path is not valid', async () => {
+    //Arrange
+    hashFilesSpy.mockImplementation((somePath: string) => {
+      return new Promise<string>(resolve => {
+        resolve('');
+      });
+    });
+
+    //Act + Assert
+    expect(async () => {
+      await cacheRestore.restoreCache(packageManager, cacheDependencyPath);
+    }).rejects.toThrowError(
+      'Some specified paths were not resolved, unable to cache dependencies.'
+    );
+  });
+
+  it('should inform if cache hit is not occured', async () => {
+    //Arrange
+    hashFilesSpy.mockImplementation((somePath: string) => {
+      return new Promise<string>(resolve => {
+        resolve('file_hash');
+      });
+    });
+
+    restoreCacheSpy.mockImplementation(() => {
+      return new Promise<string>(resolve => {
+        resolve('');
+      });
+    });
+
+    //Act + Assert
+    await cacheRestore.restoreCache(packageManager, cacheDependencyPath);
+    expect(infoSpy).toBeCalledWith(`Cache is not found`);
+  });
+
+  it('should set output if cache hit is occured', async () => {
+    //Arrange
+    hashFilesSpy.mockImplementation((somePath: string) => {
+      return new Promise<string>(resolve => {
+        resolve('file_hash');
+      });
+    });
+
+    restoreCacheSpy.mockImplementation(() => {
+      return new Promise<string>(resolve => {
+        resolve('cache_key');
+      });
+    });
+
+    //Act + Assert
+    await cacheRestore.restoreCache(packageManager, cacheDependencyPath);
+    expect(setOutputSpy).toBeCalledWith('cache-hit', true);
+  });
+});

__tests__/cache-utils.test.ts

@@ -0,0 +1,179 @@
+import * as exec from '@actions/exec';
+import * as cache from '@actions/cache';
+import * as core from '@actions/core';
+import * as cacheUtils from '../src/cache-utils';
+import {PackageManagerInfo} from '../src/package-managers';
+
+describe('getCommandOutput', () => {
+  //Arrange
+  let getExecOutputSpy = jest.spyOn(exec, 'getExecOutput');
+
+  it('should return trimmed stdout in case of successful exit code', async () => {
+    //Arrange
+    const stdoutResult = ' stdout ';
+    const trimmedStdout = stdoutResult.trim();
+
+    getExecOutputSpy.mockImplementation((commandLine: string) => {
+      return new Promise<exec.ExecOutput>(resolve => {
+        resolve({exitCode: 0, stdout: stdoutResult, stderr: ''});
+      });
+    });
+
+    //Act + Assert
+    return cacheUtils
+      .getCommandOutput('command')
+      .then(data => expect(data).toBe(trimmedStdout));
+  });
+
+  it('should return error in case of unsuccessful exit code', async () => {
+    //Arrange
+    const stderrResult = 'error message';
+
+    getExecOutputSpy.mockImplementation((commandLine: string) => {
+      return new Promise<exec.ExecOutput>(resolve => {
+        resolve({exitCode: 10, stdout: '', stderr: stderrResult});
+      });
+    });
+
+    //Act + Assert
+    expect(async () => {
+      await cacheUtils.getCommandOutput('command');
+    }).rejects.toThrow();
+  });
+});
+
+describe('getPackageManagerInfo', () => {
+  it('should return package manager info in case of valid package manager name', async () => {
+    //Arrange
+    const packageManagerName = 'default';
+    const expectedResult = {
+      dependencyFilePattern: 'go.sum',
+      cacheFolderCommandList: ['go env GOMODCACHE', 'go env GOCACHE']
+    };
+
+    //Act + Assert
+    return cacheUtils
+      .getPackageManagerInfo(packageManagerName)
+      .then(data => expect(data).toEqual(expectedResult));
+  });
+
+  it('should throw the error in case of invalid package manager name', async () => {
+    //Arrange
+    const packageManagerName = 'invalidName';
+
+    //Act + Assert
+    expect(async () => {
+      await cacheUtils.getPackageManagerInfo(packageManagerName);
+    }).rejects.toThrow();
+  });
+});
+
+describe('getCacheDirectoryPath', () => {
+  //Arrange
+  let getExecOutputSpy = jest.spyOn(exec, 'getExecOutput');
+
+  const validPackageManager: PackageManagerInfo = {
+    dependencyFilePattern: 'go.sum',
+    cacheFolderCommandList: ['go env GOMODCACHE', 'go env GOCACHE']
+  };
+
+  it('should return path to the cache folders which specified package manager uses', async () => {
+    //Arrange
+    getExecOutputSpy.mockImplementation((commandLine: string) => {
+      return new Promise<exec.ExecOutput>(resolve => {
+        resolve({exitCode: 0, stdout: 'path/to/cache/folder', stderr: ''});
+      });
+    });
+
+    const expectedResult = ['path/to/cache/folder', 'path/to/cache/folder'];
+
+    //Act + Assert
+    return cacheUtils
+      .getCacheDirectoryPath(validPackageManager)
+      .then(data => expect(data).toEqual(expectedResult));
+  });
+
+  it('should throw if the specified package name is invalid', async () => {
+    getExecOutputSpy.mockImplementation((commandLine: string) => {
+      return new Promise<exec.ExecOutput>(resolve => {
+        resolve({exitCode: 10, stdout: '', stderr: 'Error message'});
+      });
+    });
+
+    //Act + Assert
+    expect(async () => {
+      await cacheUtils.getCacheDirectoryPath(validPackageManager);
+    }).rejects.toThrow();
+  });
+});
+
+describe('isCacheFeatureAvailable', () => {
+  //Arrange
+  let isFeatureAvailableSpy = jest.spyOn(cache, 'isFeatureAvailable');
+  let warningSpy = jest.spyOn(core, 'warning');
+
+  it('should return true when cache feature is available', () => {
+    //Arrange
+    isFeatureAvailableSpy.mockImplementation(() => {
+      return true;
+    });
+
+    let functionResult;
+
+    //Act
+    functionResult = cacheUtils.isCacheFeatureAvailable();
+
+    //Assert
+    expect(functionResult).toBeTruthy();
+  });
+
+  it('should warn when cache feature is unavailable and GHES is not used ', () => {
+    //Arrange
+    isFeatureAvailableSpy.mockImplementation(() => {
+      return false;
+    });
+
+    process.env['GITHUB_SERVER_URL'] = 'https://github.com';
+
+    let warningMessage =
+      'The runner was not able to contact the cache service. Caching will be skipped';
+
+    //Act
+    cacheUtils.isCacheFeatureAvailable();
+
+    //Assert
+    expect(warningSpy).toHaveBeenCalledWith(warningMessage);
+  });
+
+  it('should return false when cache feature is unavailable', () => {
+    //Arrange
+    isFeatureAvailableSpy.mockImplementation(() => {
+      return false;
+    });
+
+    process.env['GITHUB_SERVER_URL'] = 'https://github.com';
+
+    let functionResult;
+
+    //Act
+    functionResult = cacheUtils.isCacheFeatureAvailable();
+
+    //Assert
+    expect(functionResult).toBeFalsy();
+  });
+
+  it('should throw when cache feature is unavailable and GHES is used', () => {
+    //Arrange
+    isFeatureAvailableSpy.mockImplementation(() => {
+      return false;
+    });
+
+    process.env['GITHUB_SERVER_URL'] = 'https://nongithub.com';
+
+    let errorMessage =
+      'Cache action is only supported on GHES version >= 3.5. If you are on version >=3.5 Please check with GHES admin if Actions cache service is enabled or not.';
+
+    //Act + Assert
+    expect(() => cacheUtils.isCacheFeatureAvailable()).toThrow(errorMessage);
+  });
+});

__tests__/data/go.mod

@@ -0,0 +1,12 @@
+module example.com/mymodule
+
+go 1.14
+
+require (
+	example.com/othermodule v1.2.3
+	example.com/thismodule v1.2.3
+	example.com/thatmodule v1.2.3
+)
+
+replace example.com/thatmodule => ../thatmodule
+exclude example.com/thismodule v1.3.0

__tests__/data/versions-manifest.json

@@ -1,4 +1,29 @@
 [
+    {
+      "version": "1.17.6",
+      "stable": true,
+      "release_url": "https://github.com/actions/go-versions/releases/tag/1.17.6-1668090892",
+      "files": [
+        {
+          "filename": "go-1.17.6-darwin-x64.tar.gz",
+          "arch": "x64",
+          "platform": "darwin",
+          "download_url": "https://github.com/actions/go-versions/releases/download/1.17.6-1668090892/go-1.17.6-darwin-x64.tar.gz"
+        },
+        {
+          "filename": "go-1.17.6-linux-x64.tar.gz",
+          "arch": "x64",
+          "platform": "linux",
+          "download_url": "https://github.com/actions/go-versions/releases/download/1.17.6-1668090892/go-1.17.6-linux-x64.tar.gz"
+        },
+        {
+          "filename": "go-1.17.6-win32-x64.zip",
+          "arch": "x64",
+          "platform": "win32",
+          "download_url": "https://github.com/actions/go-versions/releases/download/1.17.6-1668090892/go-1.17.6-win32-x64.zip"
+        }
+      ]
+    },
     {
       "version": "1.12.17",
       "stable": true,

__tests__/setup-go.test.ts

@@ -19,6 +19,8 @@ describe('setup-go', () => {
   let os = {} as any;
 
   let inSpy: jest.SpyInstance;
+  let getBooleanInputSpy: jest.SpyInstance;
+  let exportVarSpy: jest.SpyInstance;
   let findSpy: jest.SpyInstance;
   let cnSpy: jest.SpyInstance;
   let logSpy: jest.SpyInstance;
@@ -26,25 +28,30 @@ describe('setup-go', () => {
   let platSpy: jest.SpyInstance;
   let archSpy: jest.SpyInstance;
   let dlSpy: jest.SpyInstance;
-  let exSpy: jest.SpyInstance;
+  let extractTarSpy: jest.SpyInstance;
   let cacheSpy: jest.SpyInstance;
   let dbgSpy: jest.SpyInstance;
   let whichSpy: jest.SpyInstance;
   let existsSpy: jest.SpyInstance;
+  let readFileSpy: jest.SpyInstance;
   let mkdirpSpy: jest.SpyInstance;
   let execSpy: jest.SpyInstance;
   let getManifestSpy: jest.SpyInstance;
 
-  beforeAll(() => {
+  beforeAll(async () => {
-    process.env['GITHUB_PATH'] = ''; // Stub out ENV file functionality so we can verify it writes to standard out
+    process.env['GITHUB_ENV'] = ''; // Stub out Environment file functionality so we can verify it writes to standard out (toolkit is backwards compatible)
-    console.log('::stop-commands::stoptoken'); // Disable executing of runner commands when running tests in actions
+  }, 100000);
-  });
 
   beforeEach(() => {
+    process.env['GITHUB_PATH'] = ''; // Stub out ENV file functionality so we can verify it writes to standard out
+
     // @actions/core
     inputs = {};
     inSpy = jest.spyOn(core, 'getInput');
     inSpy.mockImplementation(name => inputs[name]);
+    getBooleanInputSpy = jest.spyOn(core, 'getBooleanInput');
+    getBooleanInputSpy.mockImplementation(name => inputs[name]);
+    exportVarSpy = jest.spyOn(core, 'exportVariable');
 
     // node
     os = {};
@@ -57,7 +64,7 @@ describe('setup-go', () => {
     // @actions/tool-cache
     findSpy = jest.spyOn(tc, 'find');
     dlSpy = jest.spyOn(tc, 'downloadTool');
-    exSpy = jest.spyOn(tc, 'extractTar');
+    extractTarSpy = jest.spyOn(tc, 'extractTar');
     cacheSpy = jest.spyOn(tc, 'cacheDir');
     getSpy = jest.spyOn(im, 'getVersionsDist');
     getManifestSpy = jest.spyOn(tc, 'getManifestFromRepo');
@@ -65,6 +72,7 @@ describe('setup-go', () => {
     // io
     whichSpy = jest.spyOn(io, 'which');
     existsSpy = jest.spyOn(fs, 'existsSync');
+    readFileSpy = jest.spyOn(fs, 'readFileSync');
     mkdirpSpy = jest.spyOn(io, 'mkdirP');
 
     // gets
@@ -81,7 +89,7 @@ describe('setup-go', () => {
     });
     logSpy.mockImplementation(line => {
       // uncomment to debug
-      // process.stderr.write('log:' + line + '\n');
+      //process.stderr.write('log:' + line + '\n');
     });
     dbgSpy.mockImplementation(msg => {
       // uncomment to see debug output
@@ -90,15 +98,20 @@ describe('setup-go', () => {
   });
 
   afterEach(() => {
-    jest.resetAllMocks();
+    //jest.resetAllMocks();
     jest.clearAllMocks();
     //jest.restoreAllMocks();
   });
 
   afterAll(async () => {
-    console.log('::stoptoken::'); // Re-enable executing of runner commands when running tests in actions
+    jest.restoreAllMocks();
   }, 100000);
 
+  it('can extract the major.minor.patch version from a given Go version string', async () => {
+    const goVersionOutput = 'go version go1.16.6 darwin/amd64';
+    expect(main.parseGoVersion(goVersionOutput)).toBe('1.16.6');
+  });
+
   it('can find 1.9.7 from manifest on osx', async () => {
     os.platform = 'darwin';
     os.arch = 'x64';
@@ -143,7 +156,7 @@ describe('setup-go', () => {
     os.arch = 'x64';
 
     // spec: 1.13.0 => 1.13
-    let match: im.IGoVersion | undefined = await im.findMatch('1.13.0', true);
+    let match: im.IGoVersion | undefined = await im.findMatch('1.13.0');
     expect(match).toBeDefined();
     let version: string = match ? match.version : '';
     expect(version).toBe('go1.13');
@@ -156,7 +169,7 @@ describe('setup-go', () => {
     os.arch = 'x64';
 
     // spec: 1.13 => 1.13.7 (latest)
-    let match: im.IGoVersion | undefined = await im.findMatch('1.13', true);
+    let match: im.IGoVersion | undefined = await im.findMatch('1.13');
     expect(match).toBeDefined();
     let version: string = match ? match.version : '';
     expect(version).toBe('go1.13.7');
@@ -169,7 +182,7 @@ describe('setup-go', () => {
     os.arch = 'x64';
 
     // spec: ^1.13.6 => 1.13.7
-    let match: im.IGoVersion | undefined = await im.findMatch('^1.13.6', true);
+    let match: im.IGoVersion | undefined = await im.findMatch('^1.13.6');
     expect(match).toBeDefined();
     let version: string = match ? match.version : '';
     expect(version).toBe('go1.13.7');
@@ -182,7 +195,7 @@ describe('setup-go', () => {
     os.arch = 'x32';
 
     // spec: 1 => 1.13.7 (latest)
-    let match: im.IGoVersion | undefined = await im.findMatch('1', true);
+    let match: im.IGoVersion | undefined = await im.findMatch('1');
     expect(match).toBeDefined();
     let version: string = match ? match.version : '';
     expect(version).toBe('go1.13.7');
@@ -195,10 +208,7 @@ describe('setup-go', () => {
     os.arch = 'x64';
 
     // spec: 1.14, stable=false => go1.14rc1
-    let match: im.IGoVersion | undefined = await im.findMatch(
+    let match: im.IGoVersion | undefined = await im.findMatch('1.14.0-rc.1');
-      '1.14.0-rc1',
-      false
-    );
     expect(match).toBeDefined();
     let version: string = match ? match.version : '';
     expect(version).toBe('go1.14rc1');
@@ -214,7 +224,7 @@ describe('setup-go', () => {
     findSpy.mockImplementation(() => toolPath);
     await main.run();
 
-    expect(logSpy).toHaveBeenCalledWith(`Setup go stable version spec 1.13.0`);
+    expect(logSpy).toHaveBeenCalledWith(`Setup go version spec 1.13.0`);
   });
 
   it('evaluates to stable with no input', async () => {
@@ -226,7 +236,41 @@ describe('setup-go', () => {
     findSpy.mockImplementation(() => toolPath);
     await main.run();
 
-    expect(logSpy).toHaveBeenCalledWith(`Setup go stable version spec 1.13.0`);
+    expect(logSpy).toHaveBeenCalledWith(`Setup go version spec 1.13.0`);
+  });
+
+  it('does not export any variables for Go versions >=1.9', async () => {
+    inputs['go-version'] = '1.13.0';
+    inSpy.mockImplementation(name => inputs[name]);
+
+    let toolPath = path.normalize('/cache/go/1.13.0/x64');
+    findSpy.mockImplementation(() => toolPath);
+
+    let vars: {[key: string]: string} = {};
+    exportVarSpy.mockImplementation((name: string, val: string) => {
+      vars[name] = val;
+    });
+
+    await main.run();
+    expect(vars).toStrictEqual({});
+  });
+
+  it('exports GOROOT for Go versions <1.9', async () => {
+    inputs['go-version'] = '1.8';
+    inSpy.mockImplementation(name => inputs[name]);
+
+    let toolPath = path.normalize('/cache/go/1.8.0/x64');
+    findSpy.mockImplementation(() => toolPath);
+
+    let vars: {[key: string]: string} = {};
+    exportVarSpy.mockImplementation((name: string, val: string) => {
+      vars[name] = val;
+    });
+
+    await main.run();
+    expect(vars).toStrictEqual({
+      GOROOT: toolPath
+    });
   });
 
   it('finds a version of go already in the cache', async () => {
@@ -270,14 +314,14 @@ describe('setup-go', () => {
     findSpy.mockImplementation(() => '');
     dlSpy.mockImplementation(() => '/some/temp/path');
     let toolPath = path.normalize('/cache/go/1.13.0/x64');
-    exSpy.mockImplementation(() => '/some/other/temp/path');
+    extractTarSpy.mockImplementation(() => '/some/other/temp/path');
     cacheSpy.mockImplementation(() => toolPath);
     await main.run();
 
     let expPath = path.join(toolPath, 'bin');
 
     expect(dlSpy).toHaveBeenCalled();
-    expect(exSpy).toHaveBeenCalled();
+    expect(extractTarSpy).toHaveBeenCalled();
     expect(cnSpy).toHaveBeenCalledWith(`::add-path::${expPath}${osm.EOL}`);
   });
 
@@ -299,7 +343,6 @@ describe('setup-go', () => {
     os.platform = 'linux';
     os.arch = 'x64';
 
-    // a version which is in the manifest
     let versionSpec = '1.12.16';
 
     inputs['go-version'] = versionSpec;
@@ -313,7 +356,7 @@ describe('setup-go', () => {
 
     dlSpy.mockImplementation(async () => '/some/temp/path');
     let toolPath = path.normalize('/cache/go/1.12.16/x64');
-    exSpy.mockImplementation(async () => '/some/other/temp/path');
+    extractTarSpy.mockImplementation(async () => '/some/other/temp/path');
     cacheSpy.mockImplementation(async () => toolPath);
 
     await main.run();
@@ -321,7 +364,7 @@ describe('setup-go', () => {
     let expPath = path.join(toolPath, 'bin');
 
     expect(dlSpy).toHaveBeenCalled();
-    expect(exSpy).toHaveBeenCalled();
+    expect(extractTarSpy).toHaveBeenCalled();
     expect(logSpy).not.toHaveBeenCalledWith(
       'Not found in manifest.  Falling back to download directly from Go'
     );
@@ -337,7 +380,6 @@ describe('setup-go', () => {
     os.platform = 'linux';
     os.arch = 'x64';
 
-    // a version which is in the manifest
     let versionSpec = '1.12';
 
     inputs['go-version'] = versionSpec;
@@ -351,7 +393,7 @@ describe('setup-go', () => {
 
     dlSpy.mockImplementation(async () => '/some/temp/path');
     let toolPath = path.normalize('/cache/go/1.12.17/x64');
-    exSpy.mockImplementation(async () => '/some/other/temp/path');
+    extractTarSpy.mockImplementation(async () => '/some/other/temp/path');
     cacheSpy.mockImplementation(async () => toolPath);
 
     await main.run();
@@ -359,7 +401,7 @@ describe('setup-go', () => {
     let expPath = path.join(toolPath, 'bin');
 
     expect(dlSpy).toHaveBeenCalled();
-    expect(exSpy).toHaveBeenCalled();
+    expect(extractTarSpy).toHaveBeenCalled();
     expect(logSpy).not.toHaveBeenCalledWith(
       'Not found in manifest.  Falling back to download directly from Go'
     );
@@ -375,7 +417,6 @@ describe('setup-go', () => {
     os.platform = 'linux';
     os.arch = 'x64';
 
-    // a version which is not in the manifest but is in node dist
     let versionSpec = '1.12.14';
 
     inputs['go-version'] = versionSpec;
@@ -389,18 +430,18 @@ describe('setup-go', () => {
 
     dlSpy.mockImplementation(async () => '/some/temp/path');
     let toolPath = path.normalize('/cache/go/1.12.14/x64');
-    exSpy.mockImplementation(async () => '/some/other/temp/path');
+    extractTarSpy.mockImplementation(async () => '/some/other/temp/path');
     cacheSpy.mockImplementation(async () => toolPath);
 
     await main.run();
 
     let expPath = path.join(toolPath, 'bin');
-    expect(logSpy).toHaveBeenCalledWith('Setup go stable version spec 1.12.14');
+    expect(logSpy).toHaveBeenCalledWith('Setup go version spec 1.12.14');
     expect(findSpy).toHaveBeenCalled();
     expect(logSpy).toHaveBeenCalledWith('Attempting to download 1.12.14...');
     expect(dlSpy).toHaveBeenCalled();
     expect(logSpy).toHaveBeenCalledWith('matching 1.12.14...');
-    expect(exSpy).toHaveBeenCalled();
+    expect(extractTarSpy).toHaveBeenCalled();
     expect(logSpy).toHaveBeenCalledWith(
       'Not found in manifest.  Falling back to download directly from Go'
     );
@@ -559,11 +600,11 @@ describe('setup-go', () => {
 
   // 1.13.1 => 1.13.1
   // 1.13 => 1.13.0
-  // 1.10beta1 => 1.10.0-beta1, 1.10rc1 => 1.10.0-rc1
+  // 1.10beta1 => 1.10.0-beta.1, 1.10rc1 => 1.10.0-rc.1
-  // 1.8.5beta1 => 1.8.5-beta1, 1.8.5rc1 => 1.8.5-rc1
+  // 1.8.5beta1 => 1.8.5-beta.1, 1.8.5rc1 => 1.8.5-rc.1
   it('converts prerelease versions', async () => {
-    expect(im.makeSemver('1.10beta1')).toBe('1.10.0-beta1');
+    expect(im.makeSemver('1.10beta1')).toBe('1.10.0-beta.1');
-    expect(im.makeSemver('1.10rc1')).toBe('1.10.0-rc1');
+    expect(im.makeSemver('1.10rc1')).toBe('1.10.0-rc.1');
   });
 
   it('converts dot zero versions', async () => {
@@ -573,4 +614,230 @@ describe('setup-go', () => {
   it('does not convert exact versions', async () => {
     expect(im.makeSemver('1.13.1')).toBe('1.13.1');
   });
+
+  describe('check-latest flag', () => {
+    it("use local version and don't check manifest if check-latest is not specified", async () => {
+      os.platform = 'linux';
+      os.arch = 'x64';
+
+      inputs['go-version'] = '1.16';
+      inputs['check-latest'] = false;
+
+      const toolPath = path.normalize('/cache/go/1.16.1/x64');
+      findSpy.mockReturnValue(toolPath);
+      await main.run();
+
+      expect(logSpy).toHaveBeenCalledWith(`Found in cache @ ${toolPath}`);
+      expect(logSpy).not.toHaveBeenCalledWith(
+        'Attempting to resolve the latest version from the manifest...'
+      );
+    });
+
+    it('check latest version and resolve it from local cache', async () => {
+      os.platform = 'linux';
+      os.arch = 'x64';
+
+      inputs['go-version'] = '1.16';
+      inputs['check-latest'] = true;
+
+      const toolPath = path.normalize('/cache/go/1.16.1/x64');
+      findSpy.mockReturnValue(toolPath);
+      dlSpy.mockImplementation(async () => '/some/temp/path');
+      extractTarSpy.mockImplementation(async () => '/some/other/temp/path');
+      cacheSpy.mockImplementation(async () => toolPath);
+
+      await main.run();
+
+      expect(logSpy).toHaveBeenCalledWith('Setup go version spec 1.16');
+      expect(logSpy).toHaveBeenCalledWith(`Found in cache @ ${toolPath}`);
+    });
+
+    it('check latest version and install it from manifest', async () => {
+      os.platform = 'linux';
+      os.arch = 'x64';
+
+      const versionSpec = '1.17';
+      const patchVersion = '1.17.6';
+      inputs['go-version'] = versionSpec;
+      inputs['stable'] = 'true';
+      inputs['check-latest'] = true;
+
+      findSpy.mockImplementation(() => '');
+      dlSpy.mockImplementation(async () => '/some/temp/path');
+      const toolPath = path.normalize('/cache/go/1.17.5/x64');
+      extractTarSpy.mockImplementation(async () => '/some/other/temp/path');
+      cacheSpy.mockImplementation(async () => toolPath);
+      const expectedUrl =
+        'https://github.com/actions/go-versions/releases/download/1.17.6-1668090892/go-1.17.6-darwin-x64.tar.gz';
+
+      await main.run();
+
+      expect(logSpy).toHaveBeenCalledWith(
+        `Setup go version spec ${versionSpec}`
+      );
+      expect(logSpy).toHaveBeenCalledWith(
+        'Attempting to resolve the latest version from the manifest...'
+      );
+      expect(logSpy).toHaveBeenCalledWith(`Resolved as '${patchVersion}'`);
+      expect(logSpy).toHaveBeenCalledWith(
+        `Attempting to download ${patchVersion}...`
+      );
+      expect(logSpy).toHaveBeenCalledWith('Extracting Go...');
+      expect(logSpy).toHaveBeenCalledWith('Adding to the cache ...');
+      expect(logSpy).toHaveBeenCalledWith('Added go to the path');
+      expect(logSpy).toHaveBeenCalledWith(
+        `Successfully set up Go version ${versionSpec}`
+      );
+    });
+
+    it('fallback to dist if version is not found in manifest', async () => {
+      os.platform = 'linux';
+      os.arch = 'x64';
+
+      let versionSpec = '1.13';
+
+      inputs['go-version'] = versionSpec;
+      inputs['check-latest'] = true;
+      inputs['always-auth'] = false;
+      inputs['token'] = 'faketoken';
+
+      // ... but not in the local cache
+      findSpy.mockImplementation(() => '');
+
+      dlSpy.mockImplementation(async () => '/some/temp/path');
+      let toolPath = path.normalize('/cache/go/1.13.7/x64');
+      extractTarSpy.mockImplementation(async () => '/some/other/temp/path');
+      cacheSpy.mockImplementation(async () => toolPath);
+
+      await main.run();
+
+      let expPath = path.join(toolPath, 'bin');
+
+      expect(dlSpy).toHaveBeenCalled();
+      expect(extractTarSpy).toHaveBeenCalled();
+      expect(logSpy).toHaveBeenCalledWith(
+        'Attempting to resolve the latest version from the manifest...'
+      );
+      expect(logSpy).toHaveBeenCalledWith(
+        `Failed to resolve version ${versionSpec} from manifest`
+      );
+      expect(logSpy).toHaveBeenCalledWith(
+        `Attempting to download ${versionSpec}...`
+      );
+      expect(cnSpy).toHaveBeenCalledWith(`::add-path::${expPath}${osm.EOL}`);
+    });
+
+    it('fallback to dist if manifest is not available', async () => {
+      os.platform = 'linux';
+      os.arch = 'x64';
+
+      let versionSpec = '1.13';
+
+      process.env['GITHUB_PATH'] = '';
+
+      inputs['go-version'] = versionSpec;
+      inputs['check-latest'] = true;
+      inputs['always-auth'] = false;
+      inputs['token'] = 'faketoken';
+
+      // ... but not in the local cache
+      findSpy.mockImplementation(() => '');
+      getManifestSpy.mockImplementation(() => {
+        throw new Error('Unable to download manifest');
+      });
+
+      dlSpy.mockImplementation(async () => '/some/temp/path');
+      let toolPath = path.normalize('/cache/go/1.13.7/x64');
+      extractTarSpy.mockImplementation(async () => '/some/other/temp/path');
+      cacheSpy.mockImplementation(async () => toolPath);
+
+      await main.run();
+
+      let expPath = path.join(toolPath, 'bin');
+
+      expect(logSpy).toHaveBeenCalledWith(
+        `Failed to resolve version ${versionSpec} from manifest`
+      );
+      expect(dlSpy).toHaveBeenCalled();
+      expect(extractTarSpy).toHaveBeenCalled();
+      expect(logSpy).toHaveBeenCalledWith(
+        'Attempting to resolve the latest version from the manifest...'
+      );
+      expect(logSpy).toHaveBeenCalledWith(
+        'Unable to resolve a version from the manifest...'
+      );
+      expect(logSpy).toHaveBeenCalledWith(
+        `Failed to resolve version ${versionSpec} from manifest`
+      );
+      expect(logSpy).toHaveBeenCalledWith(
+        `Attempting to download ${versionSpec}...`
+      );
+
+      expect(cnSpy).toHaveBeenCalledWith(`::add-path::${expPath}${osm.EOL}`);
+    });
+  });
+
+  describe('go-version-file', () => {
+    const goModContents = `module example.com/mymodule
+
+go 1.14
+
+require (
+	example.com/othermodule v1.2.3
+	example.com/thismodule v1.2.3
+	example.com/thatmodule v1.2.3
+)
+
+replace example.com/thatmodule => ../thatmodule
+exclude example.com/thismodule v1.3.0
+`;
+
+    it('reads version from go.mod', async () => {
+      inputs['go-version-file'] = 'go.mod';
+      existsSpy.mockImplementation(path => true);
+      readFileSpy.mockImplementation(() => Buffer.from(goModContents));
+
+      await main.run();
+
+      expect(logSpy).toHaveBeenCalledWith('Setup go version spec 1.14');
+      expect(logSpy).toHaveBeenCalledWith('Attempting to download 1.14...');
+      expect(logSpy).toHaveBeenCalledWith('matching 1.14...');
+    });
+
+    it('reads version from .go-version', async () => {
+      inputs['go-version-file'] = '.go-version';
+      existsSpy.mockImplementation(path => true);
+      readFileSpy.mockImplementation(() => Buffer.from(`1.13.0${osm.EOL}`));
+
+      await main.run();
+
+      expect(logSpy).toHaveBeenCalledWith('Setup go version spec 1.13.0');
+      expect(logSpy).toHaveBeenCalledWith('Attempting to download 1.13.0...');
+      expect(logSpy).toHaveBeenCalledWith('matching 1.13.0...');
+    });
+
+    it('is overwritten by go-version', async () => {
+      inputs['go-version'] = '1.13.1';
+      inputs['go-version-file'] = 'go.mod';
+      existsSpy.mockImplementation(path => true);
+      readFileSpy.mockImplementation(() => Buffer.from(goModContents));
+
+      await main.run();
+
+      expect(logSpy).toHaveBeenCalledWith('Setup go version spec 1.13.1');
+      expect(logSpy).toHaveBeenCalledWith('Attempting to download 1.13.1...');
+      expect(logSpy).toHaveBeenCalledWith('matching 1.13.1...');
+    });
+
+    it('reports a read failure', async () => {
+      inputs['go-version-file'] = 'go.mod';
+      existsSpy.mockImplementation(path => false);
+
+      await main.run();
+
+      expect(cnSpy).toHaveBeenCalledWith(
+        `::error::The specified go version file at: go.mod does not exist${osm.EOL}`
+      );
+    });
+  });
 });

action.yml

@@ -1,15 +1,29 @@
 name: 'Setup Go environment'
 description: 'Setup a Go environment and add it to the PATH'
 author: 'GitHub'
-inputs: 
+inputs:
   go-version:
     description: 'The Go version to download (if necessary) and use. Supports semver spec and ranges.'
-  stable:
+  go-version-file:
-    description: 'Whether to download only stable versions'
+    description: 'Path to the go.mod file.'
-    default: 'true'
+  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.
     default: ${{ github.token }}
+  cache:
+    description: Used to specify whether caching is needed. Set to true, if you'd like to enable caching.
+    default: false
+  cache-dependency-path:
+    description: 'Used to specify the path to a dependency file - go.sum'
+outputs:
+  go-version:
+    description: 'The installed Go version. Useful when given a version range as input.'  
+  cache-hit: 
+    description: 'A boolean value to indicate if a cache was hit'
 runs:
-  using: 'node12'
+  using: 'node16'
-  main: 'dist/index.js'
+  main: 'dist/setup/index.js'
+  post: 'dist/cache-save/index.js'
+  post-if: success()

docs/adrs/0000-caching-dependencies.md

@@ -0,0 +1,69 @@
+# 0. Caching dependencies
+Date: 2022-04-13
+
+Status: Accepted
+
+# Context
+`actions/setup-go` is the one of the most popular action related to Golang in GitHub Actions. Many customers use it in conjunction with [actions/cache](https://github.com/actions/cache) to speed up dependency installation process.  
+See more examples on proper usage in [actions/cache documentation](https://github.com/actions/cache/blob/main/examples.md#go---modules).
+
+# Goals & Anti-Goals
+Integration of caching functionality into `actions/setup-go` action will bring the following benefits for action users:
+- Decrease the entry threshold for using the cache for Go dependencies and simplify initial configuration
+- Simplify YAML pipelines because there will be no need for additional steps to enable caching
+- More users will use cache for Go so more customers will have fast builds!
+
+We don't pursue the goal to provide wide customization of caching in scope of `actions/setup-go` action. The purpose of this integration is covering ~90% of basic use-cases. If user needs flexible customization, we should advice them to use `actions/cache` directly.
+
+# Decision
+- Add `cache` input parameter to `actions/setup-go`. For now, input will accept the following values: 
+  - `true` - enable caching for go dependencies
+  - `false`- disable caching for go dependencies. This value will be set as default value
+- Cache feature will be disabled by default to make sure that we don't break existing customers. We will consider enabling cache by default in next major releases
+- Action will try to search a go.sum files in the repository and throw error in the scenario that it was not found
+- The hash of found file will be used as cache key (the same approach like [actions/cache](https://github.com/actions/cache/blob/main/examples.md#go---modules) recommends)
+- The following key cache will be used `${{ runner.os }}-go${{ go-version }}-${{ hashFiles('<go.sum-path>') }}`
+- Action will cache global cache from the `go env GOMODCACHE` and `go env GOCACHE` commands.
+- Add a `cache-dependency-path` input parameter to `actions/setup-go`. The new input will accept an array or regex of dependency files. The field will accept a path (relative to the repository root) to dependency files. If the provided path contains wildcards, the action will search all matching files and calculate a common hash like the ${{ hashFiles('**/go.sum') }} YAML construction does.
+
+# Example of real use-cases
+
+ - With cache
+
+```yml
+steps:
+- uses: actions/checkout@v3
+- uses: actions/setup-go@v3
+  with:
+    go-version: '18'
+    cache: true
+```
+
+ - With cache-dependency-path
+
+ ```yml
+steps:
+- uses: actions/checkout@v3
+- uses: actions/setup-go@v3
+  with:
+    go-version: '18'
+    cache: true
+    cache-dependency-path: **/go.sum
+```
+
+ ```yml
+steps:
+- uses: actions/checkout@v3
+- uses: actions/setup-go@v3
+  with:
+    go-version: '18'
+    cache: true
+    cache-dependency-path: |
+        **/go.sum
+        **/go.mod
+```
+
+# Release process
+
+As soon as functionality is implemented, we will release minor update of action. No need to bump major version since there are no breaking changes for existing users.
+After that, we will update [starter-workflows](https://github.com/actions/starter-workflows/blob/main/ci/go.yml)

package.json

@@ -5,7 +5,7 @@
   "description": "setup go action",
   "main": "lib/setup-go.js",
   "scripts": {
-    "build": "tsc && ncc build",
+    "build": "tsc && ncc build -o dist/setup src/setup-go.ts && ncc build -o dist/cache-save src/cache-save.ts",
     "format": "prettier --write **/*.ts",
     "format-check": "prettier --check **/*.ts",
     "test": "jest --coverage",
@@ -23,17 +23,20 @@
   "author": "GitHub",
   "license": "MIT",
   "dependencies": {
-    "@actions/core": "^1.2.6",
+    "@actions/cache": "^3.0.0",
-    "@actions/http-client": "^1.0.6",
+    "@actions/core": "^1.6.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"
   },
   "devDependencies": {
     "@types/jest": "^27.0.2",
-    "@types/node": "^12.0.4",
+    "@types/node": "^16.11.25",
     "@types/semver": "^6.0.0",
-    "@zeit/ncc": "^0.21.0",
+    "@vercel/ncc": "^0.33.4",
     "jest": "^27.2.5",
     "jest-circus": "^27.2.5",
     "nock": "^10.0.6",

src/cache-restore.ts

@@ -0,0 +1,63 @@
+import * as cache from '@actions/cache';
+import * as core from '@actions/core';
+import * as glob from '@actions/glob';
+import path from 'path';
+import fs from 'fs';
+
+import {State, Outputs} from './constants';
+import {PackageManagerInfo} from './package-managers';
+import {getCacheDirectoryPath, getPackageManagerInfo} from './cache-utils';
+
+export const restoreCache = async (
+  packageManager: string,
+  cacheDependencyPath?: string
+) => {
+  const packageManagerInfo = await getPackageManagerInfo(packageManager);
+  const platform = process.env.RUNNER_OS;
+  const versionSpec = core.getInput('go-version');
+
+  const cachePaths = await getCacheDirectoryPath(packageManagerInfo);
+
+  const dependencyFilePath = cacheDependencyPath
+    ? cacheDependencyPath
+    : findDependencyFile(packageManagerInfo);
+  const fileHash = await glob.hashFiles(dependencyFilePath);
+
+  if (!fileHash) {
+    throw new Error(
+      'Some specified paths were not resolved, unable to cache dependencies.'
+    );
+  }
+
+  const primaryKey = `setup-go-${platform}-go-${versionSpec}-${fileHash}`;
+  core.debug(`primary key is ${primaryKey}`);
+
+  core.saveState(State.CachePrimaryKey, primaryKey);
+
+  const cacheKey = await cache.restoreCache(cachePaths, primaryKey);
+  core.setOutput(Outputs.CacheHit, Boolean(cacheKey));
+
+  if (!cacheKey) {
+    core.info(`Cache is not found`);
+    core.setOutput(Outputs.CacheHit, false);
+    return;
+  }
+
+  core.saveState(State.CacheMatchedKey, cacheKey);
+  core.info(`Cache restored from key: ${cacheKey}`);
+};
+
+const findDependencyFile = (packageManager: PackageManagerInfo) => {
+  let dependencyFile = packageManager.dependencyFilePattern;
+  const workspace = process.env.GITHUB_WORKSPACE!;
+  const rootContent = fs.readdirSync(workspace);
+
+  const goSumFileExists = rootContent.includes(dependencyFile);
+  if (!goSumFileExists) {
+    throw new Error(
+      `Dependencies file is not found in ${workspace}. Supported file pattern: ${dependencyFile}`
+    );
+  }
+
+  return path.join(workspace, dependencyFile);
+};

src/cache-save.ts

@@ -0,0 +1,73 @@
+import * as core from '@actions/core';
+import * as cache from '@actions/cache';
+import fs from 'fs';
+import {State} from './constants';
+import {getCacheDirectoryPath, getPackageManagerInfo} from './cache-utils';
+
+// Catch and log any unhandled exceptions.  These exceptions can leak out of the uploadChunk method in
+// @actions/toolkit when a failed upload closes the file descriptor causing any in-process reads to
+// throw an uncaught exception.  Instead of failing this action, just warn.
+process.on('uncaughtException', e => {
+  const warningPrefix = '[warning]';
+  core.info(`${warningPrefix}${e.message}`);
+});
+
+export async function run() {
+  try {
+    await cachePackages();
+  } catch (error) {
+    core.setFailed(error.message);
+  }
+}
+
+const cachePackages = async () => {
+  const cacheInput = core.getBooleanInput('cache');
+  if (!cacheInput) {
+    return;
+  }
+
+  const packageManager = 'default';
+
+  const state = core.getState(State.CacheMatchedKey);
+  const primaryKey = core.getState(State.CachePrimaryKey);
+
+  const packageManagerInfo = await getPackageManagerInfo(packageManager);
+
+  const cachePaths = await getCacheDirectoryPath(packageManagerInfo);
+
+  const nonExistingPaths = cachePaths.filter(
+    cachePath => !fs.existsSync(cachePath)
+  );
+
+  if (nonExistingPaths.length === cachePaths.length) {
+    throw new Error(`There are no cache folders on the disk`);
+  }
+
+  if (nonExistingPaths.length) {
+    logWarning(
+      `Cache folder path is retrieved but doesn't exist on disk: ${nonExistingPaths.join(
+        ', '
+      )}`
+    );
+  }
+
+  if (primaryKey === state) {
+    core.info(
+      `Cache hit occurred on the primary key ${primaryKey}, not saving cache.`
+    );
+    return;
+  }
+
+  const cacheId = await cache.saveCache(cachePaths, primaryKey);
+  if (cacheId === -1) {
+    return;
+  }
+  core.info(`Cache saved with the key: ${primaryKey}`);
+};
+
+export function logWarning(message: string): void {
+  const warningPrefix = '[warning]';
+  core.info(`${warningPrefix}${message}`);
+}
+
+run();

src/cache-utils.ts

@@ -0,0 +1,75 @@
+import * as cache from '@actions/cache';
+import * as core from '@actions/core';
+import * as exec from '@actions/exec';
+import {supportedPackageManagers, PackageManagerInfo} from './package-managers';
+
+export const getCommandOutput = async (toolCommand: string) => {
+  let {stdout, stderr, exitCode} = await exec.getExecOutput(
+    toolCommand,
+    undefined,
+    {ignoreReturnCode: true}
+  );
+
+  if (exitCode) {
+    stderr = !stderr.trim()
+      ? `The '${toolCommand}' command failed with exit code: ${exitCode}`
+      : stderr;
+    throw new Error(stderr);
+  }
+
+  return stdout.trim();
+};
+
+export const getPackageManagerInfo = async (packageManager: string) => {
+  if (!supportedPackageManagers[packageManager]) {
+    throw new Error(
+      `It's not possible to use ${packageManager}, please, check correctness of the package manager name spelling.`
+    );
+  }
+  const obtainedPackageManager = supportedPackageManagers[packageManager];
+
+  return obtainedPackageManager;
+};
+
+export const getCacheDirectoryPath = async (
+  packageManagerInfo: PackageManagerInfo
+) => {
+  let pathList = await Promise.all(
+    packageManagerInfo.cacheFolderCommandList.map(command =>
+      getCommandOutput(command)
+    )
+  );
+
+  const emptyPaths = pathList.filter(item => !item);
+
+  if (emptyPaths.length) {
+    throw new Error(`Could not get cache folder paths.`);
+  }
+
+  return pathList;
+};
+
+export function isGhes(): boolean {
+  const ghUrl = new URL(
+    process.env['GITHUB_SERVER_URL'] || 'https://github.com'
+  );
+  return ghUrl.hostname.toUpperCase() !== 'GITHUB.COM';
+}
+
+export function isCacheFeatureAvailable(): boolean {
+  if (!cache.isFeatureAvailable()) {
+    if (isGhes()) {
+      throw new Error(
+        'Cache action is only supported on GHES version >= 3.5. If you are on version >=3.5 Please check with GHES admin if Actions cache service is enabled or not.'
+      );
+    } else {
+      core.warning(
+        'The runner was not able to contact the cache service. Caching will be skipped'
+      );
+    }
+
+    return false;
+  }
+
+  return true;
+}

src/constants.ts

@@ -0,0 +1,8 @@
+export enum State {
+  CachePrimaryKey = 'CACHE_KEY',
+  CacheMatchedKey = 'CACHE_RESULT'
+}
+
+export enum Outputs {
+  CacheHit = 'cache-hit'
+}

src/installer.ts

@@ -4,6 +4,7 @@ import * as path from 'path';
 import * as semver from 'semver';
 import * as httpm from '@actions/http-client';
 import * as sys from './system';
+import fs from 'fs';
 import os from 'os';
 
 type InstallationType = 'dist' | 'manifest';
@@ -30,12 +31,27 @@ export interface IGoVersionInfo {
 
 export async function getGo(
   versionSpec: string,
-  stable: boolean,
+  checkLatest: boolean,
   auth: string | undefined
 ) {
   let osPlat: string = os.platform();
   let osArch: string = os.arch();
 
+  if (checkLatest) {
+    core.info('Attempting to resolve the latest version from the manifest...');
+    const resolvedVersion = await resolveVersionFromManifest(
+      versionSpec,
+      true,
+      auth
+    );
+    if (resolvedVersion) {
+      versionSpec = resolvedVersion;
+      core.info(`Resolved as '${versionSpec}'`);
+    } else {
+      core.info(`Failed to resolve version ${versionSpec} from manifest`);
+    }
+  }
+
   // check cache
   let toolPath: string;
   toolPath = tc.find('go', versionSpec);
@@ -52,7 +68,7 @@ export async function getGo(
   // Try download from internal distribution (popular versions only)
   //
   try {
-    info = await getInfoFromManifest(versionSpec, stable, auth);
+    info = await getInfoFromManifest(versionSpec, true, auth);
     if (info) {
       downloadPath = await installGoVersion(info, auth);
     } else {
@@ -79,7 +95,7 @@ export async function getGo(
   // Download from storage.googleapis.com
   //
   if (!downloadPath) {
-    info = await getInfoFromDist(versionSpec, stable);
+    info = await getInfoFromDist(versionSpec);
     if (!info) {
       throw new Error(
         `Unable to find Go version '${versionSpec}' for platform ${osPlat} and architecture ${osArch}.`
@@ -97,6 +113,20 @@ export async function getGo(
   return downloadPath;
 }
 
+async function resolveVersionFromManifest(
+  versionSpec: string,
+  stable: boolean,
+  auth: string | undefined
+): Promise<string | undefined> {
+  try {
+    const info = await getInfoFromManifest(versionSpec, stable, auth);
+    return info?.resolvedVersion;
+  } catch (err) {
+    core.info('Unable to resolve a version from the manifest...');
+    core.debug(err.message);
+  }
+}
+
 async function installGoVersion(
   info: IGoVersionInfo,
   auth: string | undefined
@@ -161,11 +191,10 @@ export async function getInfoFromManifest(
 }
 
 async function getInfoFromDist(
-  versionSpec: string,
+  versionSpec: string
-  stable: boolean
 ): Promise<IGoVersionInfo | null> {
   let version: IGoVersion | undefined;
-  version = await findMatch(versionSpec, stable);
+  version = await findMatch(versionSpec);
   if (!version) {
     return null;
   }
@@ -181,8 +210,7 @@ async function getInfoFromDist(
 }
 
 export async function findMatch(
-  versionSpec: string,
+  versionSpec: string
-  stable: boolean
 ): Promise<IGoVersion | undefined> {
   let archFilter = sys.getArch();
   let platFilter = sys.getPlatform();
@@ -203,18 +231,8 @@ export async function findMatch(
     let candidate: IGoVersion = candidates[i];
     let version = makeSemver(candidate.version);
 
-    // 1.13.0 is advertised as 1.13 preventing being able to match exactly 1.13.0
-    // since a semver of 1.13 would match latest 1.13
-    let parts: string[] = version.split('.');
-    if (parts.length == 2) {
-      version = version + '.0';
-    }
-
     core.debug(`check ${version} satisfies ${versionSpec}`);
-    if (
+    if (semver.satisfies(version, versionSpec)) {
-      semver.satisfies(version, versionSpec) &&
-      (!stable || candidate.stable === stable)
-    ) {
       goFile = candidate.files.find(file => {
         core.debug(
           `${file.arch}===${archFilter} && ${file.os}===${platFilter}`
@@ -254,20 +272,41 @@ export async function getVersionsDist(
 // Convert the go version syntax into semver for semver matching
 // 1.13.1 => 1.13.1
 // 1.13 => 1.13.0
-// 1.10beta1 => 1.10.0-beta1, 1.10rc1 => 1.10.0-rc1
+// 1.10beta1 => 1.10.0-beta.1, 1.10rc1 => 1.10.0-rc.1
-// 1.8.5beta1 => 1.8.5-beta1, 1.8.5rc1 => 1.8.5-rc1
+// 1.8.5beta1 => 1.8.5-beta.1, 1.8.5rc1 => 1.8.5-rc.1
 export function makeSemver(version: string): string {
   version = version.replace('go', '');
-  version = version.replace('beta', '-beta').replace('rc', '-rc');
+  version = version.replace('beta', '-beta.').replace('rc', '-rc.');
   let parts = version.split('-');
 
-  let verPart: string = parts[0];
+  let semVersion = semver.coerce(parts[0])?.version;
-  let prereleasePart = parts.length > 1 ? `-${parts[1]}` : '';
+  if (!semVersion) {
-
+    throw new Error(
-  let verParts: string[] = verPart.split('.');
+      `The version: ${version} can't be changed to SemVer notation`
-  if (verParts.length == 2) {
+    );
-    verPart += '.0';
   }
 
-  return `${verPart}${prereleasePart}`;
+  if (!parts[1]) {
+    return semVersion;
+  }
+
+  const fullVersion = semver.valid(`${semVersion}-${parts[1]}`);
+
+  if (!fullVersion) {
+    throw new Error(
+      `The version: ${version} can't be changed to SemVer notation`
+    );
+  }
+  return fullVersion;
+}
+
+export function parseGoVersionFile(versionFilePath: string): string {
+  const contents = fs.readFileSync(versionFilePath).toString();
+
+  if (path.basename(versionFilePath) === 'go.mod') {
+    const match = contents.match(/^go (\d+(\.\d+)*)/m);
+    return match ? match[1] : '';
+  }
+
+  return contents.trim();
 }

src/main.ts

@@ -1,10 +1,12 @@
 import * as core from '@actions/core';
 import * as io from '@actions/io';
 import * as installer from './installer';
+import * as semver from 'semver';
 import path from 'path';
+import {restoreCache} from './cache-restore';
+import {isGhes, isCacheFeatureAvailable} from './cache-utils';
 import cp from 'child_process';
 import fs from 'fs';
-import {URL} from 'url';
 
 export async function run() {
   try {
@@ -12,31 +14,41 @@ export async function run() {
     // versionSpec is optional.  If supplied, install / use from the tool cache
     // If not supplied then problem matchers will still be setup.  Useful for self-hosted.
     //
-    let versionSpec = core.getInput('go-version');
+    const versionSpec = resolveVersionInput();
 
-    // stable will be true unless false is the exact input
+    const cache = core.getBooleanInput('cache');
-    // since getting unstable versions should be explicit
+    core.info(`Setup go version spec ${versionSpec}`);
-    let stable = (core.getInput('stable') || 'true').toUpperCase() === 'TRUE';
-
-    core.info(`Setup go ${stable ? 'stable' : ''} version spec ${versionSpec}`);
 
     if (versionSpec) {
       let token = core.getInput('token');
       let auth = !token || isGhes() ? undefined : `token ${token}`;
 
-      const installDir = await installer.getGo(versionSpec, stable, auth);
+      const checkLatest = core.getBooleanInput('check-latest');
+      const installDir = await installer.getGo(versionSpec, checkLatest, auth);
 
-      core.exportVariable('GOROOT', installDir);
       core.addPath(path.join(installDir, 'bin'));
       core.info('Added go to the path');
 
+      const version = installer.makeSemver(versionSpec);
+      // Go versions less than 1.9 require GOROOT to be set
+      if (semver.lt(version, '1.9.0')) {
+        core.info('Setting GOROOT for Go version < 1.9');
+        core.exportVariable('GOROOT', installDir);
+      }
+
       let added = await addBinToPath();
       core.debug(`add bin ${added}`);
-      core.info(`Successfully setup go version ${versionSpec}`);
+      core.info(`Successfully set up Go version ${versionSpec}`);
+    }
+
+    if (cache && isCacheFeatureAvailable()) {
+      const packageManager = 'default';
+      const cacheDependencyPath = core.getInput('cache-dependency-path');
+      await restoreCache(packageManager, cacheDependencyPath);
     }
 
     // add problem matchers
-    const matchersPath = path.join(__dirname, '..', 'matchers.json');
+    const matchersPath = path.join(__dirname, '../..', 'matchers.json');
     core.info(`##[add-matcher]${matchersPath}`);
 
     // output the version actually being used
@@ -44,6 +56,8 @@ export async function run() {
     let goVersion = (cp.execSync(`${goPath} version`) || '').toString();
     core.info(goVersion);
 
+    core.setOutput('go-version', parseGoVersion(goVersion));
+
     core.startGroup('go env');
     let goEnv = (cp.execSync(`${goPath} env`) || '').toString();
     core.info(goEnv);
@@ -63,19 +77,19 @@ export async function addBinToPath(): Promise<boolean> {
   }
 
   let buf = cp.execSync('go env GOPATH');
-  if (buf) {
+  if (buf.length > 1) {
     let gp = buf.toString().trim();
     core.debug(`go env GOPATH :${gp}:`);
     if (!fs.existsSync(gp)) {
       // some of the hosted images have go install but not profile dir
       core.debug(`creating ${gp}`);
-      io.mkdirP(gp);
+      await io.mkdirP(gp);
     }
 
     let bp = path.join(gp, 'bin');
     if (!fs.existsSync(bp)) {
       core.debug(`creating ${bp}`);
-      io.mkdirP(bp);
+      await io.mkdirP(bp);
     }
 
     core.addPath(bp);
@@ -84,9 +98,36 @@ export async function addBinToPath(): Promise<boolean> {
   return added;
 }
 
-function isGhes(): boolean {
+export function parseGoVersion(versionString: string): string {
-  const ghUrl = new URL(
+  // get the installed version as an Action output
-    process.env['GITHUB_SERVER_URL'] || 'https://github.com'
+  // based on go/src/cmd/go/internal/version/version.go:
-  );
+  // fmt.Printf("go version %s %s/%s\n", runtime.Version(), runtime.GOOS, runtime.GOARCH)
-  return ghUrl.hostname.toUpperCase() !== 'GITHUB.COM';
+  // expecting go<version> for runtime.Version()
+  return versionString.split(' ')[2].slice('go'.length);
+}
+
+function resolveVersionInput(): string {
+  let version = core.getInput('go-version');
+  const versionFilePath = core.getInput('go-version-file');
+
+  if (version && versionFilePath) {
+    core.warning(
+      'Both go-version and go-version-file inputs are specified, only go-version will be used'
+    );
+  }
+
+  if (version) {
+    return version;
+  }
+
+  if (versionFilePath) {
+    if (!fs.existsSync(versionFilePath)) {
+      throw new Error(
+        `The specified go version file at: ${versionFilePath} does not exist`
+      );
+    }
+    version = installer.parseGoVersionFile(versionFilePath);
+  }
+
+  return version;
 }

src/package-managers.ts

@@ -0,0 +1,15 @@
+type SupportedPackageManagers = {
+  [prop: string]: PackageManagerInfo;
+};
+
+export interface PackageManagerInfo {
+  dependencyFilePattern: string;
+  cacheFolderCommandList: string[];
+}
+
+export const supportedPackageManagers: SupportedPackageManagers = {
+  default: {
+    dependencyFilePattern: 'go.sum',
+    cacheFolderCommandList: ['go env GOMODCACHE', 'go env GOCACHE']
+  }
+};

src/system.ts

@@ -1,4 +1,4 @@
-let os = require('os');
+const os = require('os');
 
 export function getPlatform(): string {
   // darwin and linux match already

tsconfig.json

@@ -4,9 +4,6 @@
     // "incremental": true,                   /* Enable incremental compilation */
     "target": "es6",                          /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */
     "module": "commonjs",                     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
-    "lib": [
-      "es6"
-    ],
     // "allowJs": true,                       /* Allow javascript files to be compiled. */
     // "checkJs": true,                       /* Report errors in .js files. */
     // "jsx": "preserve",                     /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
@@ -48,7 +45,8 @@
     // "typeRoots": [],                       /* List of folders to include type definitions from. */
     // "types": [],                           /* Type declaration files to be included in compilation. */
     // "allowSyntheticDefaultImports": true,  /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
-    "esModuleInterop": true                   /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
+    "esModuleInterop": true,                  /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
+    "sourceMap": true,
     // "preserveSymlinks": true,              /* Do not resolve the real path of symlinks. */
     // "allowUmdGlobalAccess": true,          /* Allow accessing UMD globals from modules. */