Fallback to downloading from go.dev/dl instead of storage.googleapis.com/golang (v4) (#690 )

* fallback download url update * license update * license update * license updates * updates
V4 - Add workflow file for publishing releases to immutable action package (#583 )
2026-11-10 23:03:39 +03:00 · 2025-12-15 11:30:28 -06:00 · 2025-04-17 10:36:03 -05:00 · 2025-04-13 22:11:47 -05:00
121 changed files with 162483 additions and 159707 deletions
@@ -7,7 +7,7 @@ assignees: ''

 ---

-<!--- Please direct any generic questions related to actions to our support community forum at https://github.com/orgs/community/discussions/categories/actions --->
+<!--- Please direct any generic questions related to actions to our support community forum at https://github.community/c/code-to-cloud/github-actions/41 --->
 <!--- Before opening up a new bug report, please make sure to check for similar existing issues -->

 **Description:**
@@ -5,7 +5,7 @@ title: ''
 labels: feature request, needs triage
 assignees: ''
 ---
-<!--- Please direct any generic questions related to actions to our support community forum at https://github.com/orgs/community/discussions/categories/actions --->
+<!--- Please direct any generic questions related to actions to our support community forum at https://github.community/c/code-to-cloud/github-actions/41 --->
 <!--- Before opening up a new feature request, please make sure to check for similar existing issues and pull requests -->

 **Description:**
@@ -1,22 +0,0 @@
-# To get started with Dependabot version updates, you'll need to specify which
-# package ecosystems to update and where the package manifests are located.
-# Please see the documentation for all configuration options:
-# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
-
-version: 2
-updates:
-  # Enable version updates for npm
-  - package-ecosystem: 'npm'
-    # Look for `package.json` and `lock` files in the `root` directory
-    directory: '/'
-    # Check the npm registry for updates every day (weekdays)
-    schedule:
-      interval: 'weekly'
-
-  # Enable version updates for GitHub Actions
-  - package-ecosystem: 'github-actions'
-    # Workflow files stored in the default location of `.github/workflows`
-    # You don't need to specify `/.github/workflows` for `directory`. You can use `directory: "/"`.
-    directory: '/'
-    schedule:
-      interval: 'weekly'
@@ -14,5 +14,3 @@ jobs:
  call-basic-validation:
    name: Basic validation
    uses: actions/reusable-workflows/.github/workflows/basic-validation.yml@main
-    with:
-      node-version: '24.x'
@@ -15,5 +15,3 @@ jobs:
  call-check-dist:
    name: Check dist/
    uses: actions/reusable-workflows/.github/workflows/check-dist.yml@main
-    with:
-      node-version: '24.x'
@@ -1,143 +0,0 @@
-name: Validate Microsoft build of Go
-
-on:
-  push:
-    branches:
-      - main
-    paths-ignore:
-      - '**.md'
-  pull_request:
-    paths-ignore:
-      - '**.md'
-
-jobs:
-  microsoft-basic:
-    name: 'Microsoft build of Go ${{ matrix.go-version }} on ${{ matrix.os }}'
-    runs-on: ${{ matrix.os }}
-    strategy:
-      fail-fast: false
-      matrix:
-        os: [ubuntu-latest, windows-latest, macos-latest]
-        go-version: ['1.25', '1.24']
-    steps:
-      - uses: actions/checkout@v6
-
-      - name: Setup Microsoft build of Go ${{ matrix.go-version }}
-        uses: ./
-        with:
-          go-version: ${{ matrix.go-version }}
-          go-download-base-url: 'https://aka.ms/golang/release/latest'
-          cache: false
-
-      - name: Verify Go installation
-        run: go version
-
-      - name: Verify Go env
-        run: go env
-
-      - name: Verify Go is functional
-        shell: bash
-        run: |
-          # Create a simple Go program and run it
-          mkdir -p /tmp/test-go && cd /tmp/test-go
-          cat > main.go << 'EOF'
-          package main
-          import "fmt"
-          func main() {
-            fmt.Println("Hello from Microsoft build of Go!")
-          }
-          EOF
-          go run main.go
-
-  microsoft-env-var:
-    name: 'Microsoft build of Go via env var on ${{ matrix.os }}'
-    runs-on: ${{ matrix.os }}
-    strategy:
-      fail-fast: false
-      matrix:
-        os: [ubuntu-latest, windows-latest, macos-latest]
-    env:
-      GO_DOWNLOAD_BASE_URL: 'https://aka.ms/golang/release/latest'
-    steps:
-      - uses: actions/checkout@v6
-
-      - name: Setup Microsoft build of Go via environment variable
-        uses: ./
-        with:
-          go-version: '1.25'
-          cache: false
-
-      - name: Verify Go installation
-        run: go version
-
-      - name: Verify Go is functional
-        shell: bash
-        run: |
-          mkdir -p /tmp/test-go && cd /tmp/test-go
-          cat > main.go << 'EOF'
-          package main
-          import "fmt"
-          func main() {
-            fmt.Println("Hello from Microsoft build of Go via env var!")
-          }
-          EOF
-          go run main.go
-
-  microsoft-architecture:
-    name: 'Microsoft build of Go arch ${{ matrix.architecture }} on ${{ matrix.os }}'
-    runs-on: ${{ matrix.os }}
-    strategy:
-      fail-fast: false
-      matrix:
-        os: [ubuntu-latest, macos-latest]
-        architecture: [x64]
-        include:
-          - os: macos-latest
-            architecture: arm64
-    steps:
-      - uses: actions/checkout@v6
-
-      - name: Setup Microsoft build of Go with architecture
-        uses: ./
-        with:
-          go-version: '1.25'
-          go-download-base-url: 'https://aka.ms/golang/release/latest'
-          architecture: ${{ matrix.architecture }}
-          cache: false
-
-      - name: Verify Go installation
-        run: go version
-
-  microsoft-with-cache:
-    name: 'Microsoft build of Go with caching on ${{ matrix.os }}'
-    runs-on: ${{ matrix.os }}
-    strategy:
-      fail-fast: false
-      matrix:
-        os: [ubuntu-latest, windows-latest, macos-latest]
-    steps:
-      - uses: actions/checkout@v6
-
-      - name: Setup Microsoft build of Go with caching
-        uses: ./
-        with:
-          go-version: '1.25'
-          go-download-base-url: 'https://aka.ms/golang/release/latest'
-          cache: true
-
-      - name: Verify Go installation
-        run: go version
-
-      - name: Verify Go is functional
-        shell: bash
-        run: |
-          mkdir -p /tmp/test-go && cd /tmp/test-go
-          go mod init test
-          cat > main.go << 'EOF'
-          package main
-          import "fmt"
-          func main() {
-            fmt.Println("Hello from cached Microsoft build of Go!")
-          }
-          EOF
-          go run main.go
@@ -14,7 +14,7 @@ jobs:

    steps:
      - name: Checking out
-        uses: actions/checkout@v6
+        uses: actions/checkout@v4
      - name: Publish
        id: publish
        uses: actions/publish-immutable-action@v0.0.4
@@ -22,7 +22,7 @@ jobs:
    runs-on: ubuntu-latest
    steps:
      - name: Update the ${{ env.TAG_NAME }} tag
-        uses: actions/publish-action@v0.4.0
+        uses: actions/publish-action@v0.2.2
        with:
          source-tag: ${{ env.TAG_NAME }}
          slack-webhook: ${{ secrets.SLACK_WEBHOOK }}
@@ -18,9 +18,9 @@ jobs:
    strategy:
      fail-fast: false
      matrix:
-        os: [ubuntu-latest, windows-latest, macos-latest, macos-latest-large]
+        os: [ubuntu-latest, windows-latest, macos-latest]
    steps:
-      - uses: actions/checkout@v6
+      - uses: actions/checkout@v3
      - name: Setup Go Stable
        uses: ./
        with:
@@ -33,9 +33,9 @@ jobs:
    strategy:
      fail-fast: false
      matrix:
-        os: [ubuntu-latest, windows-latest, macos-latest, macos-latest-large]
+        os: [ubuntu-latest, windows-latest, macos-latest]
    steps:
-      - uses: actions/checkout@v6
+      - uses: actions/checkout@v3
      - name: Setup Go oldStable
        uses: ./
        with:
@@ -48,16 +48,14 @@ jobs:
    strategy:
      fail-fast: false
      matrix:
-        os: [ubuntu-latest, windows-latest, macos-latest, macos-latest-large]
+        os: [ubuntu-latest, windows-latest, macos-latest]
        version: [stable, oldstable]
        architecture: [x64, x32]
        exclude:
          - os: macos-latest
            architecture: x32
-          - os: macos-latest-large
-            architecture: x32
    steps:
-      - uses: actions/checkout@v6
+      - uses: actions/checkout@v3
      - name: Setup Go ${{ matrix.version }} ${{ matrix.architecture }}
        uses: ./
        with:
@@ -72,17 +70,11 @@ jobs:
    strategy:
      fail-fast: false
      matrix:
-        os: [macos-latest, windows-latest, ubuntu-latest, macos-latest-large]
-        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.17, 1.18, 1.19]
    steps:
      - name: Checkout
-        uses: actions/checkout@v6
+        uses: actions/checkout@v3

      - name: setup-go ${{ matrix.go }}
        uses: ./
@@ -98,10 +90,10 @@ jobs:
    strategy:
      fail-fast: false
      matrix:
-        os: [ubuntu-latest, windows-latest, macos-latest, macos-latest-large]
-        go-version: ['1.20', '1.21', '1.22', '1.23']
+        os: [ubuntu-latest, windows-latest, macos-latest]
+        go-version: [1.16, 1.17]
    steps:
-      - uses: actions/checkout@v6
+      - uses: actions/checkout@v3
      - name: Setup Go and check latest
        uses: ./
        with:
@@ -115,15 +107,15 @@ jobs:
    strategy:
      fail-fast: false
      matrix:
-        os: [ubuntu-latest, windows-latest, macos-latest, macos-latest-large]
+        os: [ubuntu-latest, windows-latest, macos-13]
    steps:
-      - uses: actions/checkout@v6
+      - 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.20.14
+        run: __tests__/verify-go.sh 1.14
        shell: bash

  go-version-file-with-gowork:
@@ -131,59 +123,28 @@ jobs:
    strategy:
      fail-fast: false
      matrix:
-        os: [ubuntu-latest, windows-latest, macos-latest, macos-latest-large]
+        os: [ubuntu-latest, windows-latest, macos-latest]
    steps:
-      - uses: actions/checkout@v6
+      - uses: actions/checkout@v3
      - name: Setup Go and check latest
        uses: ./
        with:
          go-version-file: __tests__/data/go.work
      - name: verify go
-        run: __tests__/verify-go.sh 1.21
-        shell: bash
-
-  go-version-file-with-tool-versions:
-    runs-on: ${{ matrix.os }}
-    strategy:
-      fail-fast: false
-      matrix:
-        os: [ubuntu-latest, windows-latest, macos-latest, macos-latest-large]
-    steps:
-      - uses: actions/checkout@v6
-      - name: Setup Go and check latest
-        uses: ./
-        with:
-          go-version-file: __tests__/data/.tool-versions
-      - name: verify go
-        run: __tests__/verify-go.sh 1.23.2
-        shell: bash
-
-  go-version-file-with-go-version:
-    runs-on: ${{ matrix.os }}
-    strategy:
-      fail-fast: false
-      matrix:
-        os: [ubuntu-latest, windows-latest, macos-latest, macos-latest-large]
-    steps:
-      - uses: actions/checkout@v6
-      - name: Setup Go from .go-version file
-        uses: ./
-        with:
-          go-version-file: __tests__/data/.go-version
-      - name: verify go
-        run: __tests__/verify-go.sh 1.22.4
+        run: __tests__/verify-go.sh 1.19
        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-latest-large]
-        go: [1.20.14, 1.21.10, 1.22.8, 1.23.2]
+        os: [macos-13, windows-latest, ubuntu-latest]
+        go: [1.12.16, 1.13.11, 1.14.3]
    steps:
      - name: Checkout
-        uses: actions/checkout@v6
+        uses: actions/checkout@v3

      - name: setup-go ${{ matrix.go }}
        uses: ./
@@ -195,15 +156,19 @@ 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-latest-large]
-        go: [1.11.12]
+        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@v6
+        uses: actions/checkout@v3

      - name: setup-go ${{ matrix.go }}
        uses: ./
@@ -219,23 +184,14 @@ jobs:
    strategy:
      fail-fast: false
      matrix:
-        os: [ubuntu-latest, windows-latest, macos-latest, macos-latest-large]
-        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-latest-large
-            architecture: x64
+        os: [ubuntu-latest, windows-latest, macos-latest]
+        go-version: [1.16, 1.17]
    steps:
-      - uses: actions/checkout@v6
+      - uses: actions/checkout@v3
      - name: Setup Go and check latest
        uses: ./
        with:
          go-version: ${{ matrix.go-version }}
-          architecture: ${{ matrix.architecture }}
+          architecture: x64
      - name: Verify Go
        run: go version
@@ -19,7 +19,7 @@ jobs:
        cache: [false, true]
        go: [1.20.1]
    steps:
-      - uses: actions/checkout@v6
+      - uses: actions/checkout@v3

      - name: 'Setup ${{ matrix.cache }}, cache: ${{ matrix.go }}'
        uses: ./
@@ -61,7 +61,7 @@ jobs:
            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
+          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
@@ -88,7 +88,7 @@ jobs:
      matrix:
        cache: [false, true]
    steps:
-      - uses: actions/checkout@v6
+      - uses: actions/checkout@v3

      - name: 'Setup default go, cache: ${{ matrix.cache }}'
        uses: ./
@@ -105,32 +105,10 @@ jobs:
          fi
        shell: bash

-      - name: 'Drive D: should not have Go installation, cache: ${{ matrix.cache }}'
+      - 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
-
-  hostedtoolcache:
-    name: 'Validate if hostedtoolcache works as expected'
-    runs-on: windows-latest
-    strategy:
-      matrix:
-        cache: [false]
-        go: [1.20.1]
-    steps:
-      - uses: actions/checkout@v6
-
-      - name: 'Setup ${{ matrix.go }}, cache: ${{ matrix.cache }}'
-        uses: ./
-        with:
-          go-version: ${{ matrix.go }}
-          cache: ${{ matrix.cache }}
-
-      - name: 'Setup ${{ matrix.go }}, cache: ${{ matrix.cache }} (from hostedtoolcache)'
-        uses: ./
-        with:
-          go-version: ${{ matrix.go }}
-          cache: ${{ matrix.cache }}
@@ -12,5 +12,4 @@ allowed:
  - 0bsd

 reviewed:
-  npm:
-     - "@actions/http-client"
+  npm:
@@ -3,146 +3,262 @@
 [![Basic validation](https://github.com/actions/setup-go/actions/workflows/basic-validation.yml/badge.svg)](https://github.com/actions/setup-go/actions/workflows/basic-validation.yml)
 [![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)

-This action sets up a Go environment for use in GitHub Actions by:
+This action sets up a go environment for use in actions by:

- Optionally downloading and caching a version of Go by version and adding it to the PATH
- Optionally caching Go modules and build outputs
- Registering problem matchers for error output
+- Optionally downloading and caching a version of Go by version and adding to `PATH`.
+- Registering problem matchers for error output.

-## Breaking changes in V6
+# V4

-The V6 edition of the action includes:
- **Upgraded Node.js runtime from node20 to node24**
-  > Make sure your runner is on version v2.327.1 or later to ensure compatibility with this release. See [Release Notes](https://github.com/actions/runner/releases/tag/v2.327.1)
+The V4 edition of the action offers:

- **Go toolchain**
-  - Supports both `go` and `toolchain` directives in `go.mod`. If the `toolchain` directive is present, its version is used; otherwise, the action falls back to the `go` directive.
+ - Enabled caching by default

- **Cache key update**
-  - By default, the cache key for Go modules is based on `go.mod`. To use `go.sum`, configure the `cache-dependency-path` input.
+The action will try to enable caching unless the `cache` input is explicitly set to false.

-See full release notes on the [releases page](https://github.com/actions/setup-go/releases).
+Please see "[Caching dependency files and build outputs](https://github.com/actions/setup-go#caching-dependency-files-and-build-outputs)" for more information.

-## Usage
+# V3

-See [action.yml](action.yml).
+The V3 edition of the action offers:

-<!-- start usage -->
-```yaml
- uses: actions/setup-go@v6
-  with:
-    # Version or version range of Go to use
-    go-version: '1.23'
-    
-    # Path to go.mod, go.work, .go-version, or .tool-versions file
-    # Note: if both go-version and go-version-file are provided, go-version takes precedence.
-    go-version-file: 'go.mod'
-    
-    # Set this option if you want the action to check for the latest available version
-    # Default: false
-    check-latest: false
-    
-    # GitHub token for authentication
-    token: ${{ github.token }}
-    
-    # Used to specify whether caching is needed.
-    # Default: true
-    cache: true
-    
-    # Path to dependency files for caching
-    cache-dependency-path: 'go.sum'
-    
-    # Architecture to install (auto-detected if not specified)
-    architecture: 'x64'
-    
-    # Custom base URL for Go downloads (e.g., for mirrors)
-    go-download-base-url: ''
-```
-<!-- end usage -->
+- Adds `GOBIN` to the `PATH`
+- Proxy support
+- Check latest version
+- Caching packages dependencies
+- stable and oldstable aliases
+- Bug Fixes (including issues around version matching and semver)

-**Basic:**
+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://go.dev/dl). 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@v6
-  - uses: actions/setup-go@v6
+  - uses: actions/checkout@v3
+  - uses: actions/setup-go@v4
    with:
-      go-version: '1.25' # The Go version to download (if necessary) and use.
+      go-version: '^1.13.1' # The Go version to download (if necessary) and use.
+  - run: go version
+```
+
+```yaml
+steps:
+  - uses: actions/checkout@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@v4
+    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@v4
+    with:
+      go-version: '1.16.0-beta.1' # The Go version to download (if necessary) and use.
+  - run: go version
+```
+
+# Usage
+
+See [action.yml](action.yml)
+
+## Basic
+
+```yaml
+steps:
+  - uses: actions/checkout@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
 ```

-**Version resolution behavior:**
+## Check latest version

-The action resolves the requested version in the following order:
-1. **Local cache** - Checks the local tool cache for a matching [semver](https://github.com/npm/node-semver#versions) version.
-2. **go-versions repository** - If the requested version isn’t available in the tool cache, it pulls the version manifest from the `main` branch of the [go-versions repository](https://github.com/actions/go-versions/blob/main/versions-manifest.json).
-3. **Direct download** - If that lookup misses or fails, it will fall back to downloading directly from the [official Go distribution site](https://go.dev/dl).
+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.

-To change the default behavior, please use
-the [check-latest input](docs/advanced-usage.md#check-latest-version).
+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.

-> **Note**: The `setup-go` action uses executable binaries built by the Go team and does not build Go binaries from source code.
+> Setting `check-latest` to `true` has performance implications as downloading Go versions is slower than using cached
+> versions.

-## Supported version syntax
+```yaml
+steps:
+  - uses: actions/checkout@v3
+  - uses: actions/setup-go@v4
+    with:
+      go-version: '1.14'
+      check-latest: true
+  - run: go run hello.go
+```
+
+## Using stable/oldstable aliases
+
+If `stable` is provided, action will get the latest stable version from
+the [`go-versions`](https://github.com/actions/go-versions/blob/main/versions-manifest.json) repository manifest.
+
+If `oldstable` is provided, when current release is 1.19.x, action will resolve version as 1.18.x, where x is the latest
+patch release.
+
+**Note:** using these aliases will result in same version as using corresponding minor release with `check-latest` input
+set to `true`
+
+```yaml
+steps:
+  - uses: actions/checkout@v3
+  - uses: actions/setup-go@v4
+    with:
+      go-version: 'stable'
+  - run: go run hello.go
+```
+
+```yaml
+steps:
+  - uses: actions/checkout@v3
+  - uses: actions/setup-go@v4
+    with:
+      go-version: 'oldstable'
+  - 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 [toolkit/cache](https://github.com/actions/toolkit/tree/main/packages/cache) under the hood but requires less configuration settings.
+The `cache` input is optional, and caching is turned on 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.
+
+If some problem that prevents success caching happens then the action issues the warning in the log and continues the execution of the pipeline. 
+
+**Caching in monorepos**
+
+```yaml
+steps:
+  - uses: actions/checkout@v3
+  - uses: actions/setup-go@v4
+    with:
+      go-version: '1.17'
+      check-latest: 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 or a `go.work` file that contains 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 [versions-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@v4
+    with:
+      go-version-file: 'path/to/go.mod'
+  - run: go version
+```
+
+## Matrix testing
+
+```yaml
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        go: [ '1.14', '1.13' ]
+    name: Go ${{ matrix.go }} sample
+    steps:
+      - uses: actions/checkout@v3
+      - name: Setup go
+        uses: actions/setup-go@v4
+        with:
+          go-version: ${{ matrix.go }}
+      - run: go run hello.go
+```
+
+### Supported version syntax

 The `go-version` input supports the following syntax:

- Specific versions: `1.25`, `1.24.11`, `1.24.0-rc.1`, `1.23.0-beta.1`
- SemVer version range syntax: `^1.25.1`, `~1.24.1`, `>=1.25.0-rc.1`, `<1.25.0`, `>=1.22.0 <1.24.0`
- Aliases: `stable`, `oldstable`
- Wildcards: `1.25.x`, `1.x`
+- 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`, `>=1.18.0-rc.1`

-For details on Semantic Versioning, see [the semver package documentation](https://github.com/npm/node-semver).
+For more information about semantic versioning, please refer to [semver](https://github.com/npm/node-semver)
+documentation.

-> **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.
+## Using `setup-go` on GHES

-For more usage examples, please refer to the section: [Using go-version input](docs/advanced-usage.md#using-the-go-version-input) of the [Advanced usage](docs/advanced-usage.md) guide.
+`setup-go` comes pre-installed on the appliance with GHES if Actions is enabled. When dynamically downloading Go
+distributions, `setup-go` downloads distributions from [`actions/go-versions`](https://github.com/actions/go-versions)
+on github.com (outside of the appliance). These calls to `actions/go-versions` are made via unauthenticated requests,
+which are limited
+to [60 requests per hour per IP](https://docs.github.com/en/rest/overview/resources-in-the-rest-api#rate-limiting). If
+more requests are made within the time frame, then you will start to see rate-limit errors during downloading that looks
+like: `##[error]API rate limit exceeded for...`. After that error the action will try to download versions directly
+from https://go.dev/dl, but it also can have rate limit so it's better to put token.

-## Recommended permissions
-
-When using the `setup-go` action in your GitHub Actions workflow, it is recommended to set the following permissions to ensure proper functionality:
+To get a higher rate limit, you
+can [generate a personal access token on github.com](https://github.com/settings/tokens/new) and pass it as the `token`
+input for the action:

 ```yaml
-permissions:
-  contents: read # access to check out code and install dependencies
+uses: actions/setup-go@v4
+with:
+  token: ${{ secrets.GH_DOTCOM_TOKEN }}
+  go-version: '1.18'
 ```

-## Caching dependency files and build outputs
+If the runner is not able to access github.com, any Go versions requested during a workflow run must come from the
+runner's tool cache.
+See "[Setting up the tool cache on self-hosted runners without internet access](https://docs.github.com/en/enterprise-server@3.2/admin/github-actions/managing-access-to-actions-from-githubcom/setting-up-the-tool-cache-on-self-hosted-runners-without-internet-access)"
+for more information.

-The action includes built-in caching and restoration for Go modules and build outputs. It uses
-[toolkit/cache](https://github.com/actions/toolkit/tree/main/packages/cache) under the hood, but requires less configuration.
-The `cache` input is optional, and caching is enabled by default. To disable caching, set `cache: false`.
+# License

-By default, the action looks for `go.mod` in the repository root and uses its hash as part of the cache key. Use the `cache-dependency-path` input when you have multiple dependency files, or when they’re located in different subdirectories. This input supports glob patterns.
+The scripts and documentation in this project are released under the [MIT License](LICENSE)

-If caching cannot be performed for any reason, the action logs a warning and continues workflow execution.
+# Contributions

-For examples of using `cache-dependency-path`, see the [Caching](docs/advanced-usage.md#caching) section of the [Advanced usage](docs/advanced-usage.md) guide.
-
-
-## Advanced usage
-
- [Using the go-version input](docs/advanced-usage.md#using-the-go-version-input)
- [Using the go-version-file input](docs/advanced-usage.md#using-the-go-version-file-input)
- [Check latest version](docs/advanced-usage.md#check-latest-version)
- [Caching](docs/advanced-usage.md#caching)
- [Outputs](docs/advanced-usage.md#outputs)
- [Custom download URL](docs/advanced-usage.md#custom-download-url)
- [Using `setup-go` on GHES](docs/advanced-usage.md#using-setup-go-on-ghes)
-
-## License
-
-The scripts and documentation in this project are released under the [MIT License](LICENSE).
-
-## Contributions
-
-Contributions are welcome! See our [Contributor's Guide](docs/contributors.md).
+Contributions are welcome! See [Contributor's Guide](docs/contributors.md)

 ## Code of Conduct

@@ -1,83 +1,94 @@
 import * as cache from '@actions/cache';
 import * as core from '@actions/core';
 import * as glob from '@actions/glob';
-import fs from 'fs';

 import * as cacheRestore from '../src/cache-restore';
 import * as cacheUtils from '../src/cache-utils';
 import {PackageManagerInfo} from '../src/package-managers';

 describe('restoreCache', () => {
-  let hashFilesSpy: jest.SpyInstance;
-  let getCacheDirectoryPathSpy: jest.SpyInstance;
-  let restoreCacheSpy: jest.SpyInstance;
-  let infoSpy: jest.SpyInstance;
-  let setOutputSpy: jest.SpyInstance;
+  //Arrange
+  const hashFilesSpy = jest.spyOn(glob, 'hashFiles');
+  const getCacheDirectoryPathSpy = jest.spyOn(
+    cacheUtils,
+    'getCacheDirectoryPath'
+  );
+  const restoreCacheSpy = jest.spyOn(cache, 'restoreCache');
+  const infoSpy = jest.spyOn(core, 'info');
+  const setOutputSpy = jest.spyOn(core, 'setOutput');

  const versionSpec = '1.13.1';
  const packageManager = 'default';
  const cacheDependencyPath = 'path';

-  let originalWorkspace: string | undefined;
-
  beforeEach(() => {
-    originalWorkspace = process.env.GITHUB_WORKSPACE;
-    process.env.GITHUB_WORKSPACE = '/test/workspace';
-    //Arrange
-    hashFilesSpy = jest.spyOn(glob, 'hashFiles');
-    getCacheDirectoryPathSpy = jest.spyOn(cacheUtils, 'getCacheDirectoryPath');
-    restoreCacheSpy = jest.spyOn(cache, 'restoreCache');
-    infoSpy = jest.spyOn(core, 'info');
-    setOutputSpy = jest.spyOn(core, 'setOutput');
-
    getCacheDirectoryPathSpy.mockImplementation(
      (PackageManager: PackageManagerInfo) => {
-        return Promise.resolve([
-          'cache_directory_path',
-          'cache_directory_path'
-        ]);
+        return new Promise<string[]>(resolve => {
+          resolve(['cache_directory_path', 'cache_directory_path']);
+        });
      }
    );
  });

-  afterEach(() => {
-    process.env.GITHUB_WORKSPACE = originalWorkspace;
-    jest.restoreAllMocks();
-  });
-
  it('should throw if dependency file path is not valid', async () => {
-    // Arrange
-    hashFilesSpy.mockImplementation(() => Promise.resolve(''));
-    // Act + Assert
-    await expect(
-      cacheRestore.restoreCache(
+    //Arrange
+    hashFilesSpy.mockImplementation((somePath: string) => {
+      return new Promise<string>(resolve => {
+        resolve('');
+      });
+    });
+
+    //Act + Assert
+    await expect(async () => {
+      await cacheRestore.restoreCache(
        versionSpec,
        packageManager,
        cacheDependencyPath
-      )
-    ).rejects.toThrow(
+      );
+    }).rejects.toThrow(
      'Some specified paths were not resolved, unable to cache dependencies.'
    );
  });

-  it('should inform if cache hit is not occurred', async () => {
-    // Arrange
-    hashFilesSpy.mockImplementation(() => Promise.resolve('file_hash'));
-    restoreCacheSpy.mockImplementation(() => Promise.resolve(''));
-    // Act + Assert
+  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(
      versionSpec,
      packageManager,
      cacheDependencyPath
    );
-    expect(infoSpy).toHaveBeenCalledWith('Cache is not found');
+    expect(infoSpy).toHaveBeenCalledWith(`Cache is not found`);
  });

-  it('should set output if cache hit is occurred', async () => {
-    // Arrange
-    hashFilesSpy.mockImplementation(() => Promise.resolve('file_hash'));
-    restoreCacheSpy.mockImplementation(() => Promise.resolve('cache_key'));
-    // Act + Assert
+  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(
      versionSpec,
      packageManager,
@@ -85,18 +96,4 @@ describe('restoreCache', () => {
    );
    expect(setOutputSpy).toHaveBeenCalledWith('cache-hit', true);
  });
-
-  it('should throw if dependency file is not found in workspace', async () => {
-    jest.spyOn(fs, 'readdirSync').mockReturnValue(['main.go'] as any);
-
-    await expect(
-      cacheRestore.restoreCache(
-        versionSpec,
-        packageManager
-        // No cacheDependencyPath
-      )
-    ).rejects.toThrow(
-      'Dependencies file is not found in /test/workspace. Supported file pattern: go.mod'
-    );
-  });
 });
@@ -1,155 +0,0 @@
-import * as cache from '@actions/cache';
-import * as core from '@actions/core';
-import fs from 'fs';
-
-import {run} from '../src/cache-save';
-import * as cacheUtils from '../src/cache-utils';
-import {State} from '../src/constants';
-
-describe('cache-save', () => {
-  const primaryKey = 'primary-key';
-
-  let primaryKeyValue: string;
-  let matchedKeyValue: string;
-
-  let getBooleanInputSpy: jest.SpyInstance;
-  let getStateSpy: jest.SpyInstance;
-  let infoSpy: jest.SpyInstance;
-  let warningSpy: jest.SpyInstance;
-  let debugSpy: jest.SpyInstance;
-  let setFailedSpy: jest.SpyInstance;
-  let saveCacheSpy: jest.SpyInstance;
-  let getCacheDirectoryPathSpy: jest.SpyInstance;
-  let existsSpy: jest.SpyInstance;
-
-  beforeEach(() => {
-    primaryKeyValue = primaryKey;
-    matchedKeyValue = 'matched-key';
-
-    getBooleanInputSpy = jest.spyOn(core, 'getBooleanInput');
-    getBooleanInputSpy.mockReturnValue(true);
-
-    getStateSpy = jest.spyOn(core, 'getState');
-    getStateSpy.mockImplementation((key: string) => {
-      if (key === State.CachePrimaryKey) {
-        return primaryKeyValue;
-      }
-      if (key === State.CacheMatchedKey) {
-        return matchedKeyValue;
-      }
-      return '';
-    });
-
-    infoSpy = jest.spyOn(core, 'info');
-    infoSpy.mockImplementation(() => undefined);
-
-    warningSpy = jest.spyOn(core, 'warning');
-    warningSpy.mockImplementation(() => undefined);
-
-    debugSpy = jest.spyOn(core, 'debug');
-    debugSpy.mockImplementation(() => undefined);
-
-    setFailedSpy = jest.spyOn(core, 'setFailed');
-    setFailedSpy.mockImplementation(() => undefined);
-
-    saveCacheSpy = jest.spyOn(cache, 'saveCache');
-    saveCacheSpy.mockImplementation(() => Promise.resolve(0));
-
-    getCacheDirectoryPathSpy = jest.spyOn(cacheUtils, 'getCacheDirectoryPath');
-    getCacheDirectoryPathSpy.mockImplementation(() =>
-      Promise.resolve(['cache_directory_path', 'cache_directory_path'])
-    );
-
-    existsSpy = jest.spyOn(fs, 'existsSync');
-    existsSpy.mockImplementation(() => true);
-  });
-
-  afterEach(() => {
-    jest.restoreAllMocks();
-  });
-
-  it('does not save cache when the cache input is false', async () => {
-    getBooleanInputSpy.mockReturnValue(false);
-
-    await run();
-
-    expect(saveCacheSpy).not.toHaveBeenCalled();
-    expect(warningSpy).not.toHaveBeenCalled();
-    expect(setFailedSpy).not.toHaveBeenCalled();
-  });
-
-  it('does not save cache when there are no cache folders on the disk', async () => {
-    existsSpy.mockImplementation(() => false);
-
-    await run();
-
-    expect(warningSpy).toHaveBeenCalledWith(
-      'There are no cache folders on the disk'
-    );
-    expect(saveCacheSpy).not.toHaveBeenCalled();
-    expect(setFailedSpy).not.toHaveBeenCalled();
-  });
-
-  it('does not save cache when the primary key was not generated', async () => {
-    primaryKeyValue = '';
-
-    await run();
-
-    expect(infoSpy).toHaveBeenCalledWith(
-      'Primary key was not generated. Please check the log messages above for more errors or information'
-    );
-    expect(saveCacheSpy).not.toHaveBeenCalled();
-    expect(setFailedSpy).not.toHaveBeenCalled();
-  });
-
-  it('does not save cache when a cache hit occurred on the primary key', async () => {
-    matchedKeyValue = primaryKey;
-
-    await run();
-
-    expect(infoSpy).toHaveBeenCalledWith(
-      `Cache hit occurred on the primary key ${primaryKey}, not saving cache.`
-    );
-    expect(saveCacheSpy).not.toHaveBeenCalled();
-    expect(setFailedSpy).not.toHaveBeenCalled();
-  });
-
-  it('saves cache when the primary key differs from the matched key', async () => {
-    await run();
-
-    expect(saveCacheSpy).toHaveBeenCalled();
-    expect(infoSpy).toHaveBeenCalledWith(
-      `Cache saved with the key: ${primaryKey}`
-    );
-    expect(warningSpy).not.toHaveBeenCalled();
-    expect(setFailedSpy).not.toHaveBeenCalled();
-  });
-
-  it('save with -1 cacheId , should not fail workflow', async () => {
-    saveCacheSpy.mockImplementation(() => Promise.resolve(-1));
-
-    await run();
-
-    expect(saveCacheSpy).toHaveBeenCalled();
-    expect(debugSpy).toHaveBeenCalledWith(
-      `Cache was not saved for the key: ${primaryKey}`
-    );
-    expect(infoSpy).not.toHaveBeenCalledWith(
-      `Cache saved with the key: ${primaryKey}`
-    );
-    expect(warningSpy).not.toHaveBeenCalled();
-    expect(setFailedSpy).not.toHaveBeenCalled();
-  });
-
-  it('saves with error from toolkit, should not fail workflow', async () => {
-    saveCacheSpy.mockImplementation(() =>
-      Promise.reject(new Error('Unable to reach the service'))
-    );
-
-    await run();
-
-    expect(saveCacheSpy).toHaveBeenCalled();
-    expect(warningSpy).toHaveBeenCalledWith('Unable to reach the service');
-    expect(setFailedSpy).not.toHaveBeenCalled();
-  });
-});
@@ -47,7 +47,7 @@ describe('getPackageManagerInfo', () => {
    //Arrange
    const packageManagerName = 'default';
    const expectedResult = {
-      dependencyFilePattern: 'go.mod',
+      dependencyFilePattern: 'go.sum',
      cacheFolderCommandList: ['go env GOMODCACHE', 'go env GOCACHE']
    };

@@ -73,7 +73,7 @@ describe('getCacheDirectoryPath', () => {
  const getExecOutputSpy = jest.spyOn(exec, 'getExecOutput');

  const validPackageManager: PackageManagerInfo = {
-    dependencyFilePattern: 'go.mod',
+    dependencyFilePattern: 'go.sum',
    cacheFolderCommandList: ['go env GOMODCACHE', 'go env GOCACHE']
  };

@@ -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();
-  });
-});
@@ -1 +0,0 @@
-1.22.4
@@ -1 +0,0 @@
-golang 1.23.2
Author	SHA1	Message	Date
aparnajyothi-y	7b8cf10d4e	Fallback to downloading from go.dev/dl instead of storage.googleapis.com/golang (v4) (#690 ) * fallback download url update * license update * license update * license updates * updates	2025-12-15 11:30:28 -06:00
aparnajyothi-y	19bb51245e	V4 - Add workflow file for publishing releases to immutable action package (#583 ) * Add Publish Immutable Action to V4 * file name update	2025-04-17 10:36:03 -05:00
Priya Gupta	cd53bc84d5	v4 - upgrade @actions/cache (#578 ) * Upgrade-actions/cache for v4 * audit fix * Replaced macos-latest with macos-13	2025-04-13 22:11:47 -05:00