From f5651b2b5c2d0320659f177125ecf9a362416c2e Mon Sep 17 00:00:00 2001 From: mahabaleshwars <147705296+mahabaleshwars@users.noreply.github.com> Date: Fri, 19 Sep 2025 14:53:21 +0530 Subject: [PATCH 1/9] v6 documentation update --- README.md | 33 ++++++++++++++++++++++++++++++--- 1 file changed, 30 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 564d55f..39e5396 100644 --- a/README.md +++ b/README.md @@ -10,9 +10,36 @@ This action sets up a go environment for use in actions by: # Breaking changes in V6 -- Improve toolchain handling to ensure more reliable and consistent toolchain selection and management. -- Upgraded 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) +## Node Runtime Upgrade + +Upgraded from Node 20 to Node 24 +⚠️ Action Required: Ensure your runner is on version v2.327.1 or later for compatibility. [See Release Notes](https://github.com/actions/runner/releases/tag/v2.327.1) + +## Enhanced Go Toolchain Management + +V6 introduces significant improvements to ensure reliable and consistent Go version selection: + +### Toolchain Directive Support + +Now correctly interprets both go and toolchain directives from go.mod: +``` +go 1.21.0 // Minimum required version +toolchain go1.21.6 // V6 uses this exact version +``` +###Advanced Version Resolution +Supports comprehensive version patterns: + +Comparison operators: >=1.21.0, <1.22.0 +Semantic versioning: ~1.21.0 (patch updates), ^1.21.0 (minor updates) +Wildcards: 1.21.x, 1.* + +### Intelligent Caching + +Cache keys now incorporate toolchain-specific metadata, eliminating version conflicts when switching between Go versions in your workflows. + +### Migration Impact + +These changes ensure your workflows use the exact Go version your project requires, improving build reproducibility and reducing version-related issues. For more details, see the full release notes on the [releases page](https://github.com/actions/setup-go/releases/tag/v6.0.0) From fef3dee3c521b8d9d5631fded9ba0bf5558a9317 Mon Sep 17 00:00:00 2001 From: mahabaleshwars <147705296+mahabaleshwars@users.noreply.github.com> Date: Fri, 19 Sep 2025 14:55:44 +0530 Subject: [PATCH 2/9] v6 documentation update --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 39e5396..a947b91 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ Now correctly interprets both go and toolchain directives from go.mod: go 1.21.0 // Minimum required version toolchain go1.21.6 // V6 uses this exact version ``` -###Advanced Version Resolution +### Advanced Version Resolution Supports comprehensive version patterns: Comparison operators: >=1.21.0, <1.22.0 From 871ad8f94dd80e7ce5857e2603527fd49de8319f Mon Sep 17 00:00:00 2001 From: mahabaleshwars <147705296+mahabaleshwars@users.noreply.github.com> Date: Mon, 22 Sep 2025 15:00:07 +0530 Subject: [PATCH 3/9] Readme file update --- README.md | 312 +++++++++++++++++++++++++++--------------------------- 1 file changed, 155 insertions(+), 157 deletions(-) diff --git a/README.md b/README.md index a947b91..6d6f0ee 100644 --- a/README.md +++ b/README.md @@ -3,116 +3,68 @@ [![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 actions by: +This action sets up a Go environment for use in GitHub Actions by: -- Optionally downloading and caching a version of Go by version and adding to `PATH`. -- 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 +## 🚨 Breaking Changes in V6 -## Node Runtime Upgrade +### Critical Requirements -Upgraded from Node 20 to Node 24 -⚠️ Action Required: Ensure your runner is on version v2.327.1 or later for compatibility. [See Release Notes](https://github.com/actions/runner/releases/tag/v2.327.1) +#### Node Runtime Upgrade +- **Upgraded**: Node 20 → Node 24 +- **⚠️ Action Required**: Ensure your runner is on version **v2.327.1 or later** for compatibility +- **Reference**: [Release Notes](https://github.com/actions/setup-go/releases) -## Enhanced Go Toolchain Management +### Enhanced Go Toolchain Management V6 introduces significant improvements to ensure reliable and consistent Go version selection: -### Toolchain Directive Support +#### 1. Toolchain Directive Support +Now correctly interprets both `go` and `toolchain` directives from `go.mod`: -Now correctly interprets both go and toolchain directives from go.mod: -``` +```go go 1.21.0 // Minimum required version toolchain go1.21.6 // V6 uses this exact version ``` -### Advanced Version Resolution + +#### 2. Advanced Version Resolution Supports comprehensive version patterns: -Comparison operators: >=1.21.0, <1.22.0 -Semantic versioning: ~1.21.0 (patch updates), ^1.21.0 (minor updates) -Wildcards: 1.21.x, 1.* +| Pattern Type | Examples | Description | +|-------------|----------|-------------| +| **Comparison Operators** | `>=1.21.0`, `<1.22.0` | Range-based selection | +| **Semantic Versioning** | `~1.21.0`, `^1.21.0` | Patch/minor updates | +| **Wildcards** | `1.21.x`, `1.*` | Flexible matching | -### Intelligent Caching +#### 3. Intelligent Caching +- Cache keys now incorporate toolchain-specific metadata +- Eliminates version conflicts when switching between Go versions +- Improved workflow reliability -Cache keys now incorporate toolchain-specific metadata, eliminating version conflicts when switching between Go versions in your workflows. +### Migration Benefits +✅ Exact Go version matching +✅ Improved build reproducibility +✅ Reduced version-related issues -### Migration Impact +For more details, see the [full release notes](https://github.com/actions/setup-go/releases). -These changes ensure your workflows use the exact Go version your project requires, improving build reproducibility and reducing version-related issues. +--- -For more details, see the full release notes on the [releases page](https://github.com/actions/setup-go/releases/tag/v6.0.0) - -# V5 - -The V5 edition of the action offers: +## 📋 Previous Versions +### V5 Changes - Upgraded Node.js runtime from node16 to node20 +- See [full V5 release notes](https://github.com/actions/setup-go/releases) -See full release notes on the [releases page](https://github.com/actions/setup-go/releases). +--- -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@v5 - - uses: actions/setup-go@v6 - with: - go-version: '^1.13.1' # The Go version to download (if necessary) and use. - - run: go version -``` - -```yaml -steps: - - uses: actions/checkout@v5 - - uses: actions/setup-go@v6 - 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@v5 - - uses: actions/setup-go@v6 - 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@v5 - - uses: actions/setup-go@v6 - with: - go-version: '1.16.0-beta.1' # The Go version to download (if necessary) and use. - - run: go version -``` - -# Usage +## 🚀 Usage See [action.yml](action.yml) -## Basic +### Basic Setup ```yaml steps: @@ -123,17 +75,65 @@ steps: - run: go run hello.go ``` -## Check latest version +### Version Selection Examples -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. +#### Using Semantic Versioning -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. +```yaml +# Caret notation (minor updates) +steps: + - uses: actions/checkout@v5 + - uses: actions/setup-go@v6 + with: + go-version: '^1.13.1' + - run: go version +``` -> Setting `check-latest` to `true` has performance implications as downloading Go versions is slower than using cached -> versions. +```yaml +# Comparison operators +steps: + - uses: actions/checkout@v5 + - uses: actions/setup-go@v6 + with: + go-version: '>=1.17.0' + - run: go version +``` + +> **⚠️ Important**: Always wrap version numbers in single quotes to prevent YAML parsing issues: +> ```yaml +> go-version: '1.20' # ✅ Correct +> go-version: 1.20 # ❌ Incorrect - YAML interprets as 1.2 +> ``` + +#### Pre-release Versions + +```yaml +# RC version +steps: + - uses: actions/checkout@v5 + - uses: actions/setup-go@v6 + with: + go-version: '1.18.0-rc.1' + - run: go version +``` + +```yaml +# Beta version +steps: + - uses: actions/checkout@v5 + - uses: actions/setup-go@v6 + with: + go-version: '1.16.0-beta.1' + - run: go version +``` + +--- + +## 🔧 Advanced Features + +### Check Latest Version + +The `check-latest` flag defaults to `false` for stability. Set to `true` if you want the most up-to-date Go version. ```yaml steps: @@ -145,18 +145,12 @@ steps: - run: go run hello.go ``` -## Using stable/oldstable aliases +> **Note**: Setting `check-latest: true` has performance implications as downloading Go versions is slower than using cached versions. -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` +### Using Stable/Oldstable Aliases ```yaml +# Latest stable version steps: - uses: actions/checkout@v5 - uses: actions/setup-go@v6 @@ -166,6 +160,7 @@ steps: ``` ```yaml +# Previous stable version steps: - uses: actions/checkout@v5 - uses: actions/setup-go@v6 @@ -174,19 +169,13 @@ steps: - run: go run hello.go ``` -## Caching dependency files and build outputs: +> **Note**: Using these aliases will result in the same version as using the corresponding minor release with `check-latest: true` -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. +### Caching Dependencies and Build Outputs -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. The input supports glob patterns. +The action has built-in functionality for caching and restoring go modules and build outputs. Caching is **enabled by default**. -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** +#### Caching in Monorepos ```yaml steps: @@ -196,31 +185,15 @@ steps: go-version: '1.17' check-latest: true cache-dependency-path: | - subdir/go.sum - tools/go.sum - # cache-dependency-path: "**/*.sum" - + subdir/go.sum + tools/go.sum + # Alternative: cache-dependency-path: "**/*.sum" - run: go run hello.go - ``` +``` -## Getting go version from the go.mod file +### Getting Go Version from go.mod -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. The version taken -from thils file will be: - - - The version from the `toolchain` directive, if there is one, otherwise - - The version from the `go` directive - -The version can specify a patch version or omit it altogether (e.g., `go 1.22.0` or `go 1.22`). - -If a patch version is specified, that specific patch version will be used. -If no patch version is specified, it will search for the latest available patch version in the cache, -[versions-manifest.json](https://github.com/actions/go-versions/blob/main/versions-manifest.json), and the -[official Go language website](https://golang.org/dl/?mode=json&include=all), in that order. - -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 +The action can read the Go version directly from your `go.mod` or `go.work` file: ```yaml steps: @@ -231,7 +204,13 @@ steps: - run: go version ``` -## Matrix testing +Priority order for version selection: +1. `toolchain` directive (if present) +2. `go` directive + +> **Note**: If both `go-version` and `go-version-file` are provided, `go-version` takes precedence. + +### Matrix Testing ```yaml jobs: @@ -250,26 +229,31 @@ jobs: - run: go run hello.go ``` -### Supported version syntax +--- -The `go-version` input supports the following syntax: +## 📝 Supported Version Syntax -- 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` +The `go-version` input supports: -For more information about semantic versioning, please refer to [semver](https://github.com/npm/node-semver) -documentation. +- **Specific versions**: `1.15`, `1.16.1`, `1.17.0-rc.2`, `1.16.0-beta.1` +- **SemVer ranges**: `^1.13.1`, `>=1.18.0-rc.1` -## Using `setup-go` on GHES +For more information about semantic versioning, please refer to [semver documentation](https://github.com/npm/node-semver). -`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 the action leverages the `raw API` to retrieve the version-manifest. This approach does not impose a rate limit and hence facilitates unrestricted consumption. This is particularly beneficial for GHES runners, which often share the same IP, to avoid the quick exhaustion of the unauthenticated rate limit. -If that fails as well the action will try to download versions directly from https://storage.googleapis.com/golang. +## 🏢 Using setup-go on GHES -If that fails as well you can get a higher rate limit with [generating a personal access token on github.com](https://github.com/settings/tokens/new) and passing it as the `token` input to the action: +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` on github.com (outside of the appliance). + +These calls to `actions/go-versions` are made via unauthenticated requests (limited to 60 requests per hour per IP). If more requests are needed: + +1. The action leverages the raw API to retrieve the version-manifest (no rate limit) +2. If that fails, attempts to download directly from `https://storage.googleapis.com/golang` + +### Using a Personal Access Token + +For higher rate limits: ```yaml uses: actions/setup-go@v6 @@ -278,27 +262,41 @@ with: go-version: '1.18' ``` -If the runner is not able to access github.com, any Go versions requested during a workflow run must come from the 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. +If the runner cannot 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. -## 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: +## 🔒 Recommended Permissions + +When using the setup-go action in your GitHub Actions workflow, set the following permissions: ```yaml permissions: - contents: read # access to check out code and install dependencies + contents: read # access to check out code and install dependencies ``` -# License +--- + +## ⚙️ How It Works + +### Version Resolution Order + +1. **Local cache** check for version match +2. **go-versions repository** (main branch) on cache miss +3. **Direct download** from go dist as fallback + +> **Note**: The setup-go action uses executable binaries built by the Golang team. The action does not build Go from source code. + +--- + +## 📄 License The scripts and documentation in this project are released under the [MIT License](LICENSE) -# Contributions +## 🤝 Contributions Contributions are welcome! See [Contributor's Guide](docs/contributors.md) -## Code of Conduct +## 👮 Code of Conduct -:wave: Be nice. See [our code of conduct](CODE_OF_CONDUCT.md) +👋 Be nice. See our [code of conduct](CODE_OF_CONDUCT.md) \ No newline at end of file From 8a2938124831d904c09201d9dc35593e65ba01eb Mon Sep 17 00:00:00 2001 From: mahabaleshwars <147705296+mahabaleshwars@users.noreply.github.com> Date: Mon, 22 Sep 2025 15:35:30 +0530 Subject: [PATCH 4/9] update documentation --- README.md | 401 +++++++++++++++++++++++++++++++----------------------- 1 file changed, 227 insertions(+), 174 deletions(-) diff --git a/README.md b/README.md index 6d6f0ee..0705bb6 100644 --- a/README.md +++ b/README.md @@ -1,302 +1,355 @@ -# setup-go +# Setup Go Action [![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: +- Optionally downloading and caching a version of Go by version and adding to PATH +- Registering problem matchers for error output +- Providing intelligent caching for Go modules and build outputs -- ✅ Optionally downloading and caching a version of Go by version and adding to PATH -- ✅ Registering problem matchers for error output +## Quick Start -## 🚨 Breaking Changes in V6 +```yaml +steps: + - uses: actions/checkout@v5 + - uses: actions/setup-go@v6 + with: + go-version: '1.21' + - run: go version +``` -### Critical Requirements +## Breaking Changes + +### V6 Changes #### Node Runtime Upgrade -- **Upgraded**: Node 20 → Node 24 -- **⚠️ Action Required**: Ensure your runner is on version **v2.327.1 or later** for compatibility -- **Reference**: [Release Notes](https://github.com/actions/setup-go/releases) +- **Upgraded from Node 20 to Node 24** +- ⚠️ **Action Required**: Ensure your runner is on version v2.327.1 or later for compatibility +- See [Release Notes](https://github.com/actions/runner/releases) for more details -### Enhanced Go Toolchain Management +#### Enhanced Go Toolchain Management -V6 introduces significant improvements to ensure reliable and consistent Go version selection: +V6 introduces significant improvements for reliable and consistent Go version selection: -#### 1. Toolchain Directive Support +**Toolchain Directive Support** Now correctly interprets both `go` and `toolchain` directives from `go.mod`: - ```go go 1.21.0 // Minimum required version toolchain go1.21.6 // V6 uses this exact version ``` -#### 2. Advanced Version Resolution +**Advanced Version Resolution** Supports comprehensive version patterns: +- Comparison operators: `>=1.21.0`, `<1.22.0` +- Semantic versioning: `~1.21.0` (patch updates), `^1.21.0` (minor updates) +- Wildcards: `1.21.x`, `1.*` -| Pattern Type | Examples | Description | -|-------------|----------|-------------| -| **Comparison Operators** | `>=1.21.0`, `<1.22.0` | Range-based selection | -| **Semantic Versioning** | `~1.21.0`, `^1.21.0` | Patch/minor updates | -| **Wildcards** | `1.21.x`, `1.*` | Flexible matching | +**Intelligent Caching** +Cache keys now incorporate toolchain-specific metadata, eliminating version conflicts when switching between Go versions in your workflows. -#### 3. Intelligent Caching -- Cache keys now incorporate toolchain-specific metadata -- Eliminates version conflicts when switching between Go versions -- Improved workflow reliability - -### Migration Benefits -✅ Exact Go version matching -✅ Improved build reproducibility -✅ Reduced version-related issues +**Migration Impact** +These changes ensure your workflows use the exact Go version your project requires, improving build reproducibility and reducing version-related issues. For more details, see the [full release notes](https://github.com/actions/setup-go/releases). ---- - -## 📋 Previous Versions - ### V5 Changes + - Upgraded Node.js runtime from node16 to node20 -- See [full V5 release notes](https://github.com/actions/setup-go/releases) +- See [full release notes](https://github.com/actions/setup-go/releases) for complete details ---- +## Version Resolution Behavior -## 🚀 Usage +The action follows this resolution order: +1. **Local cache** - Checks for a cached version match +2. **go-versions repository** - Pulls from the main branch of the [go-versions repository](https://github.com/actions/go-versions) +3. **Direct download** - Falls back to downloading directly from [go.dev](https://go.dev/dl/) -See [action.yml](action.yml) +To change the default behavior, use the `check-latest` input. -### Basic Setup +> **Note**: The setup-go action uses executable binaries built by the Golang team. The action does not build Go from source code. + +## Usage Examples + +### Basic Usage ```yaml steps: - uses: actions/checkout@v5 - uses: actions/setup-go@v6 with: - go-version: '1.16.1' # The Go version to download (if necessary) and use. + go-version: '1.21' - run: go run hello.go ``` -### Version Selection Examples +### Version Specifications -#### Using Semantic Versioning +#### Semantic Versioning ```yaml -# Caret notation (minor updates) steps: - uses: actions/checkout@v5 - uses: actions/setup-go@v6 with: - go-version: '^1.13.1' + go-version: '^1.21.1' # Latest patch release of 1.21.x - run: go version ``` ```yaml -# Comparison operators steps: - uses: actions/checkout@v5 - uses: actions/setup-go@v6 with: - go-version: '>=1.17.0' + go-version: '>=1.20.0' # Version 1.20.0 or higher - run: go version ``` -> **⚠️ Important**: Always wrap version numbers in single quotes to prevent YAML parsing issues: +> **Important**: Due to YAML parsing behavior, always wrap version numbers in single quotes: > ```yaml -> go-version: '1.20' # ✅ Correct -> go-version: 1.20 # ❌ Incorrect - YAML interprets as 1.2 +> go-version: '1.20' # Correct +> go-version: 1.20 # Incorrect - YAML parser interprets as 1.2 > ``` #### Pre-release Versions ```yaml -# RC version steps: - uses: actions/checkout@v5 - uses: actions/setup-go@v6 with: - go-version: '1.18.0-rc.1' + go-version: '1.22.0-rc.1' - run: go version ``` +#### Version Aliases + +**Stable Release** ```yaml -# Beta version steps: - uses: actions/checkout@v5 - uses: actions/setup-go@v6 with: - go-version: '1.16.0-beta.1' + go-version: 'stable' # Latest stable version - run: go version ``` ---- - -## 🔧 Advanced Features - -### Check Latest Version - -The `check-latest` flag defaults to `false` for stability. Set to `true` if you want the most up-to-date Go version. - +**Previous Stable Release** ```yaml steps: - uses: actions/checkout@v5 - uses: actions/setup-go@v6 with: - go-version: '1.14' - check-latest: true - - run: go run hello.go -``` - -> **Note**: Setting `check-latest: true` has performance implications as downloading Go versions is slower than using cached versions. - -### Using Stable/Oldstable Aliases - -```yaml -# Latest stable version -steps: - - uses: actions/checkout@v5 - - uses: actions/setup-go@v6 - with: - go-version: 'stable' - - run: go run hello.go -``` - -```yaml -# Previous stable version -steps: - - uses: actions/checkout@v5 - - uses: actions/setup-go@v6 - with: - go-version: 'oldstable' - - run: go run hello.go -``` - -> **Note**: Using these aliases will result in the same version as using the corresponding minor release with `check-latest: true` - -### Caching Dependencies and Build Outputs - -The action has built-in functionality for caching and restoring go modules and build outputs. Caching is **enabled by default**. - -#### Caching in Monorepos - -```yaml -steps: - - uses: actions/checkout@v5 - - uses: actions/setup-go@v6 - with: - go-version: '1.17' - check-latest: true - cache-dependency-path: | - subdir/go.sum - tools/go.sum - # Alternative: cache-dependency-path: "**/*.sum" - - run: go run hello.go -``` - -### Getting Go Version from go.mod - -The action can read the Go version directly from your `go.mod` or `go.work` file: - -```yaml -steps: - - uses: actions/checkout@v5 - - uses: actions/setup-go@v6 - with: - go-version-file: 'path/to/go.mod' + go-version: 'oldstable' # Previous stable version - run: go version ``` -Priority order for version selection: -1. `toolchain` directive (if present) -2. `go` directive +> **Note**: Using aliases is equivalent to using the corresponding minor release with `check-latest: true` + +### Version from go.mod File + +The action can automatically detect the Go version from your project's `go.mod` or `go.work` file: + +```yaml +steps: + - uses: actions/checkout@v5 + - uses: actions/setup-go@v6 + with: + go-version-file: 'go.mod' + - run: go version +``` + +**Version Resolution from go.mod:** +1. Uses the `toolchain` directive version if present +2. Falls back to the `go` directive version +3. If no patch version is specified, uses the latest available patch > **Note**: If both `go-version` and `go-version-file` are provided, `go-version` takes precedence. +### Check Latest Version + +```yaml +steps: + - uses: actions/checkout@v5 + - uses: actions/setup-go@v6 + with: + go-version: '1.21' + check-latest: true # Always check for the latest patch release + - run: go version +``` + +**Performance Considerations:** +- `check-latest: false` (default) - Uses cached versions for faster builds +- `check-latest: true` - Downloads the latest version, slower but ensures up-to-date releases + +### Caching + +#### Automatic Caching + +Caching is enabled by default and automatically handles: +- Go modules (based on `go.sum`) +- Build outputs +- Toolchain-specific metadata + +```yaml +steps: + - uses: actions/checkout@v5 + - uses: actions/setup-go@v6 + with: + go-version: '1.21' + # cache: true (default) + - run: go run hello.go +``` + +#### Custom Cache Dependencies + +For projects with multiple dependency files or monorepos: + +```yaml +steps: + - uses: actions/checkout@v5 + - uses: actions/setup-go@v6 + with: + go-version: '1.21' + cache-dependency-path: | + subdir/go.sum + tools/go.sum + - run: go run hello.go +``` + +**Using Glob Patterns:** +```yaml +cache-dependency-path: "**/*.sum" +``` + +#### Disable Caching + +```yaml +steps: + - uses: actions/checkout@v5 + - uses: actions/setup-go@v6 + with: + go-version: '1.21' + cache: false + - run: go run hello.go +``` + ### Matrix Testing +Test across multiple Go versions: + ```yaml jobs: - build: + test: runs-on: ubuntu-latest strategy: matrix: - go: [ '1.14', '1.13' ] - name: Go ${{ matrix.go }} sample + go-version: ['1.20', '1.21', '1.22'] steps: - uses: actions/checkout@v5 - - name: Setup go - uses: actions/setup-go@v6 + - uses: actions/setup-go@v6 with: - go-version: ${{ matrix.go }} - - run: go run hello.go + go-version: ${{ matrix.go-version }} + - run: go test ./... ``` ---- +## Advanced Configuration -## 📝 Supported Version Syntax +### Supported Version Syntax -The `go-version` input supports: +| Syntax Type | Example | Description | +|-------------|---------|-------------| +| Specific version | `1.21.5` | Exact version | +| Semantic range | `^1.21.0` | Compatible with 1.21.0 | +| Comparison operators | `>=1.20.0` | Version 1.20.0 or higher | +| Wildcards | `1.21.x` | Latest patch of 1.21 | +| Pre-release | `1.22.0-rc.1` | Release candidate | +| Aliases | `stable`, `oldstable` | Latest stable versions | -- **Specific versions**: `1.15`, `1.16.1`, `1.17.0-rc.2`, `1.16.0-beta.1` -- **SemVer ranges**: `^1.13.1`, `>=1.18.0-rc.1` +For more information about semantic versioning, see the [semver documentation](https://semver.org/). -For more information about semantic versioning, please refer to [semver documentation](https://github.com/npm/node-semver). - ---- - -## 🏢 Using setup-go on GHES - -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` on github.com (outside of the appliance). - -These calls to `actions/go-versions` are made via unauthenticated requests (limited to 60 requests per hour per IP). If more requests are needed: - -1. The action leverages the raw API to retrieve the version-manifest (no rate limit) -2. If that fails, attempts to download directly from `https://storage.googleapis.com/golang` - -### Using a Personal Access Token - -For higher rate limits: +### Complete Input Reference ```yaml -uses: actions/setup-go@v6 -with: - token: ${{ secrets.GH_DOTCOM_TOKEN }} - go-version: '1.18' +- uses: actions/setup-go@v6 + with: + # Version or version range of Go to use + go-version: '1.21' + + # Path to go.mod or go.work file + go-version-file: 'go.mod' + + # Check for latest version + check-latest: false + + # GitHub token for authentication + token: ${{ github.token }} + + # Enable/disable caching + cache: true + + # Path to dependency files for caching + cache-dependency-path: 'go.sum' + + # Architecture to install (auto-detected if not specified) + architecture: 'x64' ``` -If the runner cannot 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. +## Platform Support ---- +### GitHub Enterprise Server (GHES) -## 🔒 Recommended Permissions +When using setup-go on GHES: -When using the setup-go action in your GitHub Actions workflow, set the following permissions: +1. **Pre-installed**: The action comes pre-installed if Actions is enabled +2. **Rate limits**: Unauthenticated requests are limited to 60/hour per IP +3. **Authentication**: Use a personal access token for higher rate limits: + +```yaml +- uses: actions/setup-go@v6 + with: + token: ${{ secrets.GH_DOTCOM_TOKEN }} + go-version: '1.21' +``` + +4. **Offline runners**: For runners without internet access, see [Setting up the tool cache on self-hosted runners](https://docs.github.com/en/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners#using-self-hosted-runners-in-a-workflow) + +### Self-hosted Runners + +For self-hosted runners without internet access, ensure Go versions are pre-cached in the runner's tool cache. + +## Recommended Permissions ```yaml permissions: - contents: read # access to check out code and install dependencies + contents: read # Required to checkout code and install dependencies ``` ---- +## Troubleshooting -## ⚙️ How It Works +### Common Issues -### Version Resolution Order +**Version not found** +- Ensure the version exists in the [Go releases](https://go.dev/dl/) +- Check if you're using the correct version format +- Try using `check-latest: true` -1. **Local cache** check for version match -2. **go-versions repository** (main branch) on cache miss -3. **Direct download** from go dist as fallback +**Caching issues** +- Cache conflicts may occur when switching Go versions +- V6 resolves this with toolchain-specific cache keys +- Manually clear cache if needed using GitHub Actions cache management -> **Note**: The setup-go action uses executable binaries built by the Golang team. The action does not build Go from source code. +**YAML parsing** +- Always wrap version numbers in single quotes +- Avoid bare numbers that YAML might misinterpret ---- +## License -## 📄 License +The scripts and documentation in this project are released under the [MIT License](LICENSE). -The scripts and documentation in this project are released under the [MIT License](LICENSE) +## Contributions -## 🤝 Contributions +Contributions are welcome! See our [Contributor's Guide](docs/contributors.md) for details. -Contributions are welcome! See [Contributor's Guide](docs/contributors.md) +## Code of Conduct -## 👮 Code of Conduct - -👋 Be nice. See our [code of conduct](CODE_OF_CONDUCT.md) \ No newline at end of file +👋 Be nice. See our [Code of Conduct](CODE_OF_CONDUCT.md). \ No newline at end of file From 27a9e3933edbbc62927d85e855a73f8ddd514db1 Mon Sep 17 00:00:00 2001 From: mahabaleshwars <147705296+mahabaleshwars@users.noreply.github.com> Date: Mon, 22 Sep 2025 15:52:49 +0530 Subject: [PATCH 5/9] documentation update --- README.md | 323 +++++++++++++++++++++--------------------------------- 1 file changed, 122 insertions(+), 201 deletions(-) diff --git a/README.md b/README.md index 0705bb6..807be0a 100644 --- a/README.md +++ b/README.md @@ -21,335 +21,256 @@ steps: ## Breaking Changes -### V6 Changes +### V6 - Major Updates -#### Node Runtime Upgrade -- **Upgraded from Node 20 to Node 24** -- ⚠️ **Action Required**: Ensure your runner is on version v2.327.1 or later for compatibility -- See [Release Notes](https://github.com/actions/runner/releases) for more details +#### Critical Requirements +- **Node Runtime**: Upgraded from Node 20 to Node 24 +- **⚠️ Action Required**: Ensure your runner is on version **v2.327.1 or later** for compatibility +- See [Release Notes](https://github.com/actions/setup-go/releases) -#### Enhanced Go Toolchain Management +#### Enhanced Toolchain Management +V6 significantly improves toolchain handling for more reliable and consistent Go version selection: -V6 introduces significant improvements for reliable and consistent Go version selection: - -**Toolchain Directive Support** -Now correctly interprets both `go` and `toolchain` directives from `go.mod`: +**Now supports `toolchain` directive from go.mod:** ```go go 1.21.0 // Minimum required version -toolchain go1.21.6 // V6 uses this exact version +toolchain go1.21.6 // V6 uses this exact version when specified ``` -**Advanced Version Resolution** -Supports comprehensive version patterns: -- Comparison operators: `>=1.21.0`, `<1.22.0` -- Semantic versioning: `~1.21.0` (patch updates), `^1.21.0` (minor updates) -- Wildcards: `1.21.x`, `1.*` - -**Intelligent Caching** -Cache keys now incorporate toolchain-specific metadata, eliminating version conflicts when switching between Go versions in your workflows. - -**Migration Impact** -These changes ensure your workflows use the exact Go version your project requires, improving build reproducibility and reducing version-related issues. - -For more details, see the [full release notes](https://github.com/actions/setup-go/releases). - -### V5 Changes - +### V5 - Previous Updates - Upgraded Node.js runtime from node16 to node20 -- See [full release notes](https://github.com/actions/setup-go/releases) for complete details +- See [full release notes](https://github.com/actions/setup-go/releases) -## Version Resolution Behavior +## Usage -The action follows this resolution order: -1. **Local cache** - Checks for a cached version match -2. **go-versions repository** - Pulls from the main branch of the [go-versions repository](https://github.com/actions/go-versions) -3. **Direct download** - Falls back to downloading directly from [go.dev](https://go.dev/dl/) +See [action.yml](action.yml) -To change the default behavior, use the `check-latest` input. - -> **Note**: The setup-go action uses executable binaries built by the Golang team. The action does not build Go from source code. - -## Usage Examples - -### Basic Usage +### Basic Setup ```yaml steps: - uses: actions/checkout@v5 - uses: actions/setup-go@v6 with: - go-version: '1.21' + go-version: '1.16.1' # The Go version to download (if necessary) and use - run: go run hello.go ``` -### Version Specifications +### Version Selection #### Semantic Versioning ```yaml +# Using caret notation (latest patch release) steps: - uses: actions/checkout@v5 - uses: actions/setup-go@v6 with: - go-version: '^1.21.1' # Latest patch release of 1.21.x + go-version: '^1.13.1' # The Go version to download (if necessary) and use - run: go version ``` ```yaml +# Using comparison operators steps: - uses: actions/checkout@v5 - uses: actions/setup-go@v6 with: - go-version: '>=1.20.0' # Version 1.20.0 or higher + go-version: '>=1.17.0' - run: go version ``` -> **Important**: Due to YAML parsing behavior, always wrap version numbers in single quotes: +> **Note**: Due to YAML parsing behavior, always wrap version numbers in single quotes: > ```yaml > go-version: '1.20' # Correct -> go-version: 1.20 # Incorrect - YAML parser interprets as 1.2 > ``` +> Without quotes, YAML interprets `1.20` as `1.2`, which may cause unexpected behavior. #### Pre-release Versions ```yaml +# RC version steps: - uses: actions/checkout@v5 - uses: actions/setup-go@v6 with: - go-version: '1.22.0-rc.1' + go-version: '1.18.0-rc.1' # The Go version to download (if necessary) and use - run: go version ``` -#### Version Aliases - -**Stable Release** -```yaml -steps: - - uses: actions/checkout@v5 - - uses: actions/setup-go@v6 - with: - go-version: 'stable' # Latest stable version - - run: go version -``` - -**Previous Stable Release** -```yaml -steps: - - uses: actions/checkout@v5 - - uses: actions/setup-go@v6 - with: - go-version: 'oldstable' # Previous stable version - - run: go version -``` - -> **Note**: Using aliases is equivalent to using the corresponding minor release with `check-latest: true` - -### Version from go.mod File - -The action can automatically detect the Go version from your project's `go.mod` or `go.work` file: - ```yaml +# Beta version steps: - uses: actions/checkout@v5 - uses: actions/setup-go@v6 with: - go-version-file: 'go.mod' + go-version: '1.16.0-beta.1' # The Go version to download (if necessary) and use - run: go version ``` -**Version Resolution from go.mod:** -1. Uses the `toolchain` directive version if present -2. Falls back to the `go` directive version -3. If no patch version is specified, uses the latest available patch - -> **Note**: If both `go-version` and `go-version-file` are provided, `go-version` takes precedence. - ### Check Latest Version -```yaml -steps: - - uses: actions/checkout@v5 - - uses: actions/setup-go@v6 - with: - go-version: '1.21' - check-latest: true # Always check for the latest patch release - - run: go version -``` +The `check-latest` flag defaults to `false`. Use the default or set `check-latest` to `false` if you prefer stability and want to ensure a specific Go version is always used. -**Performance Considerations:** -- `check-latest: false` (default) - Uses cached versions for faster builds -- `check-latest: true` - Downloads the latest version, slower but ensures up-to-date releases +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. -### Caching - -#### Automatic Caching - -Caching is enabled by default and automatically handles: -- Go modules (based on `go.sum`) -- Build outputs -- Toolchain-specific metadata +> **Note**: Setting `check-latest` to `true` has performance implications as downloading Go versions is slower than using cached versions. ```yaml steps: - uses: actions/checkout@v5 - uses: actions/setup-go@v6 with: - go-version: '1.21' - # cache: true (default) + go-version: '1.14' + check-latest: true - run: go run hello.go ``` -#### Custom Cache Dependencies +### Using stable/oldstable Aliases -For projects with multiple dependency files or monorepos: +If `stable` is provided, action will get the latest stable version from the go-versions 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 +# Latest stable version +steps: + - uses: actions/checkout@v5 + - uses: actions/setup-go@v6 + with: + go-version: 'stable' + - run: go run hello.go +``` + +```yaml +# Previous stable version +steps: + - uses: actions/checkout@v5 + - uses: actions/setup-go@v6 + with: + go-version: 'oldstable' + - run: go run hello.go +``` + +### Caching Dependencies and Build Outputs + +The action has built-in functionality for caching and restoring go modules and build outputs. It uses `toolkit/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. The input supports glob patterns. + +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@v5 - uses: actions/setup-go@v6 with: - go-version: '1.21' + go-version: '1.17' + check-latest: true cache-dependency-path: | subdir/go.sum tools/go.sum + # Alternative: cache-dependency-path: "**/*.sum" - run: go run hello.go ``` -**Using Glob Patterns:** -```yaml -cache-dependency-path: "**/*.sum" -``` +### Getting Go Version from go.mod File -#### Disable Caching +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. The version taken from this file will be: + +1. The version from the `toolchain` directive, if there is one, otherwise +2. The version from the `go` directive + +The version can specify a patch version or omit it altogether (e.g., `go 1.22.0` or `go 1.22`). + +- If a patch version is specified, that specific patch version will be used +- If no patch version is specified, it will search for the latest available patch version in the cache, versions-manifest.json, and the official Go language website, in that order + +> **Note**: If both `go-version` and `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@v5 - uses: actions/setup-go@v6 with: - go-version: '1.21' - cache: false - - run: go run hello.go + go-version-file: 'path/to/go.mod' + - run: go version ``` ### Matrix Testing -Test across multiple Go versions: - ```yaml jobs: - test: + build: runs-on: ubuntu-latest strategy: matrix: - go-version: ['1.20', '1.21', '1.22'] + go: [ '1.14', '1.13' ] + name: Go ${{ matrix.go }} sample steps: - uses: actions/checkout@v5 - - uses: actions/setup-go@v6 + - name: Setup go + uses: actions/setup-go@v6 with: - go-version: ${{ matrix.go-version }} - - run: go test ./... + go-version: ${{ matrix.go }} + - run: go run hello.go ``` -## Advanced Configuration +## Version Resolution -### Supported Version Syntax +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) 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. -| Syntax Type | Example | Description | -|-------------|---------|-------------| -| Specific version | `1.21.5` | Exact version | -| Semantic range | `^1.21.0` | Compatible with 1.21.0 | -| Comparison operators | `>=1.20.0` | Version 1.20.0 or higher | -| Wildcards | `1.21.x` | Latest patch of 1.21 | -| Pre-release | `1.22.0-rc.1` | Release candidate | -| Aliases | `stable`, `oldstable` | Latest stable versions | +> **Note**: The setup-go action uses executable binaries which are built by Golang side. The action does not build golang from source code. -For more information about semantic versioning, see the [semver documentation](https://semver.org/). +## Supported Version Syntax -### Complete Input Reference +The `go-version` input supports the following syntax: + +- **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 more information about semantic versioning, please refer to [semver documentation](https://semver.org/). + +## Using setup-go on GHES + +`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` 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. If more requests are made within the time frame, then the action leverages the raw API to retrieve the version-manifest. This approach does not impose a rate limit and hence facilitates unrestricted consumption. This is particularly beneficial for GHES runners, which often share the same IP, to avoid the quick exhaustion of the unauthenticated rate limit. If that fails as well the action will try to download versions directly from https://storage.googleapis.com/golang. + +If that fails as well you can get a higher rate limit with generating a personal access token on github.com and passing it as the token input to the action: ```yaml -- uses: actions/setup-go@v6 - with: - # Version or version range of Go to use - go-version: '1.21' - - # Path to go.mod or go.work file - go-version-file: 'go.mod' - - # Check for latest version - check-latest: false - - # GitHub token for authentication - token: ${{ github.token }} - - # Enable/disable caching - cache: true - - # Path to dependency files for caching - cache-dependency-path: 'go.sum' - - # Architecture to install (auto-detected if not specified) - architecture: 'x64' +uses: actions/setup-go@v6 +with: + token: ${{ secrets.GH_DOTCOM_TOKEN }} + go-version: '1.18' ``` -## Platform Support - -### GitHub Enterprise Server (GHES) - -When using setup-go on GHES: - -1. **Pre-installed**: The action comes pre-installed if Actions is enabled -2. **Rate limits**: Unauthenticated requests are limited to 60/hour per IP -3. **Authentication**: Use a personal access token for higher rate limits: - -```yaml -- uses: actions/setup-go@v6 - with: - token: ${{ secrets.GH_DOTCOM_TOKEN }} - go-version: '1.21' -``` - -4. **Offline runners**: For runners without internet access, see [Setting up the tool cache on self-hosted runners](https://docs.github.com/en/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners#using-self-hosted-runners-in-a-workflow) - -### Self-hosted Runners - -For self-hosted runners without internet access, ensure Go versions are pre-cached in the runner's tool cache. +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@latest/admin/github-actions/managing-access-to-actions-from-githubcom/setting-up-the-tool-cache-on-self-hosted-runners-without-internet-access) for more information. ## 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: + ```yaml permissions: - contents: read # Required to checkout code and install dependencies + contents: read # access to check out code and install dependencies ``` -## Troubleshooting - -### Common Issues - -**Version not found** -- Ensure the version exists in the [Go releases](https://go.dev/dl/) -- Check if you're using the correct version format -- Try using `check-latest: true` - -**Caching issues** -- Cache conflicts may occur when switching Go versions -- V6 resolves this with toolchain-specific cache keys -- Manually clear cache if needed using GitHub Actions cache management - -**YAML parsing** -- Always wrap version numbers in single quotes -- Avoid bare numbers that YAML might misinterpret - ## License -The scripts and documentation in this project are released under the [MIT License](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) for details. +Contributions are welcome! See [Contributor's Guide](docs/contributors.md) ## Code of Conduct -👋 Be nice. See our [Code of Conduct](CODE_OF_CONDUCT.md). \ No newline at end of file +👋 Be nice. See our [code of conduct](CODE_OF_CONDUCT.md) \ No newline at end of file From 33a0b24c80bfd4772ae3a8ca49fcb2a3aab7cd31 Mon Sep 17 00:00:00 2001 From: mahabaleshwars <147705296+mahabaleshwars@users.noreply.github.com> Date: Mon, 22 Sep 2025 22:19:03 +0530 Subject: [PATCH 6/9] update documentation --- README.md | 311 +++++++++++++++++++++++++++++++++++------------------- 1 file changed, 205 insertions(+), 106 deletions(-) diff --git a/README.md b/README.md index 807be0a..e53ac4e 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,7 @@ [![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: + - Optionally downloading and caching a version of Go by version and adding to PATH - Registering problem matchers for error output - Providing intelligent caching for Go modules and build outputs @@ -21,30 +22,53 @@ steps: ## Breaking Changes -### V6 - Major Updates +### V6 Changes -#### Critical Requirements -- **Node Runtime**: Upgraded from Node 20 to Node 24 -- **⚠️ Action Required**: Ensure your runner is on version **v2.327.1 or later** for compatibility -- See [Release Notes](https://github.com/actions/setup-go/releases) +#### Node Runtime Upgrade +- **Upgraded from Node 20 to Node 24** +- ⚠️ **Action Required**: Ensure your runner is on version v2.327.1 or later for compatibility +- See [Release Notes](https://github.com/actions/runner/releases/tag/v2.327.1) for more details -#### Enhanced Toolchain Management -V6 significantly improves toolchain handling for more reliable and consistent Go version selection: +#### Enhanced Go Toolchain Management -**Now supports `toolchain` directive from go.mod:** +V6 introduces significant improvements for reliable and consistent Go version selection: + +**Toolchain Directive Support** +Now correctly interprets both `go` and `toolchain` directives from `go.mod`: ```go go 1.21.0 // Minimum required version -toolchain go1.21.6 // V6 uses this exact version when specified +toolchain go1.21.6 // V6 uses this exact version ``` -### V5 - Previous Updates -- Upgraded Node.js runtime from node16 to node20 -- See [full release notes](https://github.com/actions/setup-go/releases) +**Advanced Version Resolution** +Supports comprehensive version patterns: +- Comparison operators: `>=1.21.0`, `<1.22.0` +- Semantic versioning: `~1.21.0` (patch updates), `^1.21.0` (minor updates) +- Wildcards: `1.21.x`, `1.*` + +**Intelligent Caching** +Cache keys now incorporate toolchain-specific metadata, eliminating version conflicts when switching between Go versions in your workflows. + +For more details, see the [full release notes](https://github.com/actions/setup-go/releases/tag/v6.0.0). + +### V5 Changes + +- **Upgraded Node.js runtime from node16 to node20** +- See [full release notes](https://github.com/actions/setup-go/releases) for complete details + +## Version Resolution Behavior + +The action follows this resolution order: +1. **Local cache** - Checks for a cached version match +2. **go-versions repository** - Pulls from the main branch of the [go-versions repository](https://github.com/actions/go-versions/blob/main/versions-manifest.json) +3. **Direct download** - Falls back to downloading directly from [go.dev](https://storage.googleapis.com/golang) + +To change the default behavior, use the `check-latest` input. + +> **Note**: The setup-go action uses executable binaries built by the Golang team. The action does not build Go from source code. ## Usage -See [action.yml](action.yml) - ### Basic Setup ```yaml @@ -52,39 +76,37 @@ steps: - uses: actions/checkout@v5 - uses: actions/setup-go@v6 with: - go-version: '1.16.1' # The Go version to download (if necessary) and use + go-version: '1.21' - run: go run hello.go ``` -### Version Selection +### Version Specifications #### Semantic Versioning ```yaml -# Using caret notation (latest patch release) steps: - uses: actions/checkout@v5 - uses: actions/setup-go@v6 with: - go-version: '^1.13.1' # The Go version to download (if necessary) and use + go-version: '^1.21.1' # The Go version to download (if necessary) and use. - run: go version ``` ```yaml -# Using comparison operators steps: - uses: actions/checkout@v5 - uses: actions/setup-go@v6 with: - go-version: '>=1.17.0' + go-version: '>=1.20.0' - run: go version ``` -> **Note**: Due to YAML parsing behavior, always wrap version numbers in single quotes: +> **Important**: Due to YAML parsing behavior, always wrap version numbers in single quotes: > ```yaml > go-version: '1.20' # Correct +> go-version: 1.20 # Incorrect - YAML parser interprets as 1.2 > ``` -> Without quotes, YAML interprets `1.20` as `1.2`, which may cause unexpected behavior. #### Pre-release Versions @@ -94,7 +116,7 @@ steps: - uses: actions/checkout@v5 - uses: actions/setup-go@v6 with: - go-version: '1.18.0-rc.1' # The Go version to download (if necessary) and use + go-version: '1.22.0-rc.1' # The Go version to download (if necessary) and use - run: go version ``` @@ -108,89 +130,53 @@ steps: - run: go version ``` -### Check Latest Version +#### Version Aliases -The `check-latest` flag defaults to `false`. Use the default or set `check-latest` to `false` if you prefer stability and 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. - -> **Note**: Setting `check-latest` to `true` has performance implications as downloading Go versions is slower than using cached versions. - -```yaml -steps: - - uses: actions/checkout@v5 - - uses: actions/setup-go@v6 - with: - go-version: '1.14' - check-latest: true - - run: go run hello.go -``` - -### Using stable/oldstable Aliases +**Stable Release** If `stable` is provided, action will get the latest stable version from the go-versions repository manifest. +```yaml +steps: + - uses: actions/checkout@v5 + - uses: actions/setup-go@v6 + with: + go-version: 'stable' # Latest stable version + - run: go version +``` + +**Previous Stable Release** 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 -# Latest stable version steps: - uses: actions/checkout@v5 - uses: actions/setup-go@v6 with: - go-version: 'stable' - - run: go run hello.go + go-version: 'oldstable' # Previous stable version + - run: go version ``` -```yaml -# Previous stable version -steps: - - uses: actions/checkout@v5 - - uses: actions/setup-go@v6 - with: - go-version: 'oldstable' - - run: go run hello.go -``` +> **Note**: Using aliases is equivalent to using the corresponding minor release with `check-latest: true` -### Caching Dependencies and Build Outputs +### Version from go.mod File -The action has built-in functionality for caching and restoring go modules and build outputs. It uses `toolkit/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. The input supports glob patterns. - -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 +The action can automatically detect the Go version from your project's `go.mod` or `go.work` file: ```yaml steps: - uses: actions/checkout@v5 - uses: actions/setup-go@v6 with: - go-version: '1.17' - check-latest: true - cache-dependency-path: | - subdir/go.sum - tools/go.sum - # Alternative: cache-dependency-path: "**/*.sum" - - run: go run hello.go + go-version-file: 'go.mod' + - run: go version ``` -### Getting Go Version from go.mod File +**Version Resolution from go.mod:** +1. Uses the `toolchain` directive version if present +2. Falls back to the `go` directive version +3. If no patch version is specified, uses the latest available patch -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. The version taken from this file will be: - -1. The version from the `toolchain` directive, if there is one, otherwise -2. The version from the `go` directive - -The version can specify a patch version or omit it altogether (e.g., `go 1.22.0` or `go 1.22`). - -- If a patch version is specified, that specific patch version will be used -- If no patch version is specified, it will search for the latest available patch version in the cache, versions-manifest.json, and the official Go language website, in that order - -> **Note**: If both `go-version` and `go-version-file` inputs are provided then the `go-version` input is used. +> **Note**: If both `go-version` and `go-version-file` are provided, `go-version` takes precedence. The action will search for the `go.mod` file relative to the repository root: @@ -203,45 +189,156 @@ steps: - run: go version ``` +### Check Latest Version + +The check-latest flag defaults to false for stability. This ensures your workflow uses a specific, predictable Go version. +When check-latest: true: The action verifies if your cached Go version is the latest available. If not, it downloads and uses the newest version. + +```yaml +steps: + - uses: actions/checkout@v5 + - uses: actions/setup-go@v6 + with: + go-version: '1.21' + check-latest: true # Always check for the latest patch release + - run: go version +``` + +**Performance Considerations:** +- `check-latest: false` (default) - Uses cached versions for faster builds +- `check-latest: true` - Downloads the latest version, slower but ensures up-to-date releases + +### Caching + +Caching is enabled by default. The action automatically caches and restores Go modules and build outputs using toolkit/cache with minimal configuration. + +#### Automatic Caching + +Default behavior: Searches for go.sum in the repository root and uses its hash for the cache key. + +```yaml +steps: + - uses: actions/checkout@v5 + - uses: actions/setup-go@v6 + with: + go-version: '1.21' + # cache: true (default) + - run: go run hello.go +``` + +#### Advanced Caching Scenarios + +For advanced scenarios, use `cache-dependency-path` to specify: +- **Multiple dependency files**: When your project has dependencies in different directories +- **Custom locations**: When your `go.sum` files are not in the repository root +- **Monorepos**: When managing multiple Go modules in a single repository +- **Glob patterns**: For flexible file matching + +```yaml +# Example: Monorepo with multiple go.sum files +steps: + - uses: actions/checkout@v5 + - uses: actions/setup-go@v6 + with: + go-version: '1.17' + check-latest: true + cache-dependency-path: | + subdir/go.sum + tools/go.sum + - run: go run hello.go +``` + +```yaml +# Example: Using glob patterns to match all go.sum files +steps: + - uses: actions/checkout@v5 + - uses: actions/setup-go@v6 + with: + go-version: '1.17' + cache-dependency-path: "**/*.sum" + - run: go run hello.go +``` + +#### Disable Caching + +```yaml +steps: + - uses: actions/checkout@v5 + - uses: actions/setup-go@v6 + with: + go-version: '1.21' + cache: false + - run: go run hello.go +``` + +> **Note**: If caching fails, the action logs a warning but continues execution without interrupting your workflow. + ### Matrix Testing +Test across multiple Go versions: + ```yaml jobs: - build: + test: runs-on: ubuntu-latest strategy: matrix: - go: [ '1.14', '1.13' ] - name: Go ${{ matrix.go }} sample + go-version: ['1.20', '1.21', '1.22'] steps: - uses: actions/checkout@v5 - - name: Setup go - uses: actions/setup-go@v6 + - uses: actions/setup-go@v6 with: - go-version: ${{ matrix.go }} - - run: go run hello.go + go-version: ${{ matrix.go-version }} + - run: go test ./... ``` -## Version Resolution +## Advanced Configuration -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) 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. +### Supported Version Syntax -> **Note**: The setup-go action uses executable binaries which are built by Golang side. The action does not build golang from source code. +| Syntax Type | Example | Description | +|-------------|---------|-------------| +| Specific version | `1.21.5` | Exact version | +| Semantic range | `^1.21.0` | Compatible with 1.21.0 | +| Comparison operators | `>=1.20.0` | Version 1.20.0 or higher | +| Wildcards | `1.21.x` | Latest patch of 1.21 | +| Pre-release | `1.22.0-rc.1` | Release candidate | +| Aliases | `stable`, `oldstable` | Latest stable versions | -## Supported Version Syntax +For more information about semantic versioning, see the [semver documentation](https://semver.org/). -The `go-version` input supports the following syntax: +### Complete Input Reference -- **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 more information about semantic versioning, please refer to [semver documentation](https://semver.org/). +```yaml +- uses: actions/setup-go@v6 + with: + # Version or version range of Go to use + go-version: '1.21' + + # Path to go.mod or go.work file + go-version-file: 'go.mod' + + # Check for latest version + check-latest: false + + # GitHub token for authentication + token: ${{ github.token }} + + # Enable/disable caching + cache: true + + # Path to dependency files for caching + cache-dependency-path: 'go.sum' + + # Architecture to install (auto-detected if not specified) + architecture: 'x64' +``` ## Using setup-go on GHES -`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` on github.com (outside of the appliance). +setup-go comes pre-installed on GHES when Actions is enabled. For dynamic Go version downloads, the action fetches distributions from actions/go-versions on github.com (external to your appliance). -These calls to `actions/go-versions` are made via unauthenticated requests, which are limited to 60 requests per hour per IP. If more requests are made within the time frame, then the action leverages the raw API to retrieve the version-manifest. This approach does not impose a rate limit and hence facilitates unrestricted consumption. This is particularly beneficial for GHES runners, which often share the same IP, to avoid the quick exhaustion of the unauthenticated rate limit. If that fails as well the action will try to download versions directly from https://storage.googleapis.com/golang. +These calls to `actions/go-versions` are made via unauthenticated requests, which are limited to 60 requests per hour per IP. If more requests are made within the time frame, then the action leverages the raw API to retrieve the version-manifest. This approach does not impose a rate limit and hence facilitates unrestricted consumption. This is particularly beneficial for GHES runners, which often share the same IP, to avoid the quick exhaustion of the unauthenticated rate limit. If that fails as well the action will try to download versions directly from [go.dev](https://storage.googleapis.com/golang). If that fails as well you can get a higher rate limit with generating a personal access token on github.com and passing it as the token input to the action: @@ -252,7 +349,9 @@ with: go-version: '1.18' ``` -If the runner is not able to access github.com, any Go versions requested during a workflow run must come from the runner's tool cache. See ["Setting up the tool cache on self-hosted runners without internet access"](https://docs.github.com/en/enterprise-server@latest/admin/github-actions/managing-access-to-actions-from-githubcom/setting-up-the-tool-cache-on-self-hosted-runners-without-internet-access) for more information. +### Offline Runners + +For runners without github.com access, Go versions must be pre-cached in the runner's tool cache. See "Setting up the tool cache on self-hosted runners without internet access". ## Recommended Permissions @@ -260,17 +359,17 @@ When using the setup-go action in your GitHub Actions workflow, it is recommende ```yaml permissions: - contents: read # access to check out code and install dependencies + contents: read # Required to checkout code and install dependencies ``` ## License -The scripts and documentation in this project are released under the [MIT License](LICENSE) +The scripts and documentation in this project are released under the [MIT License](LICENSE). ## Contributions -Contributions are welcome! See [Contributor's Guide](docs/contributors.md) +Contributions are welcome! See our [Contributor's Guide](docs/contributors.md) for details. ## Code of Conduct -👋 Be nice. See our [code of conduct](CODE_OF_CONDUCT.md) \ No newline at end of file +👋 Be nice. See our [Code of Conduct](CODE_OF_CONDUCT.md). \ No newline at end of file From 4db01c4c33de3f17e44bd033b2bde700244a4f56 Mon Sep 17 00:00:00 2001 From: mahabaleshwars <147705296+mahabaleshwars@users.noreply.github.com> Date: Mon, 22 Sep 2025 22:20:44 +0530 Subject: [PATCH 7/9] Updated documentation --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index e53ac4e..6dd0e02 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Setup Go Action +# Setup-Go [![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) From f5d3ebe0df3a58f43f1a4e0209cb121877e508a6 Mon Sep 17 00:00:00 2001 From: mahabaleshwars <147705296+mahabaleshwars@users.noreply.github.com> Date: Thu, 25 Sep 2025 10:25:15 +0530 Subject: [PATCH 8/9] Updated Documentation --- README.md | 58 +++++++++++++++++++++++++++---------------------------- 1 file changed, 29 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index 6dd0e02..f08f51e 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Setup-Go +# setup-go [![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) @@ -16,7 +16,7 @@ steps: - uses: actions/checkout@v5 - uses: actions/setup-go@v6 with: - go-version: '1.21' + go-version: '1.23' - run: go version ``` @@ -36,18 +36,18 @@ V6 introduces significant improvements for reliable and consistent Go version se **Toolchain Directive Support** Now correctly interprets both `go` and `toolchain` directives from `go.mod`: ```go -go 1.21.0 // Minimum required version -toolchain go1.21.6 // V6 uses this exact version +go 1.23.0 // Minimum required version +toolchain go1.23.2 // V6 uses this exact version ``` **Advanced Version Resolution** Supports comprehensive version patterns: -- Comparison operators: `>=1.21.0`, `<1.22.0` -- Semantic versioning: `~1.21.0` (patch updates), `^1.21.0` (minor updates) -- Wildcards: `1.21.x`, `1.*` +- Comparison operators: `>=1.23.0`, `<1.24.0` +- Semantic versioning: `~1.23.0` (patch updates), `^1.23.0` (minor updates) +- Wildcards: `1.23.x`, `1.*` **Intelligent Caching** -Cache keys now incorporate toolchain-specific metadata, eliminating version conflicts when switching between Go versions in your workflows. +Cache keys now incorporate toolchain-specific metadata, eliminating version conflicts when switching between golang versions in your workflows. For more details, see the [full release notes](https://github.com/actions/setup-go/releases/tag/v6.0.0). @@ -76,7 +76,7 @@ steps: - uses: actions/checkout@v5 - uses: actions/setup-go@v6 with: - go-version: '1.21' + go-version: '1.23' - run: go run hello.go ``` @@ -89,7 +89,7 @@ steps: - uses: actions/checkout@v5 - uses: actions/setup-go@v6 with: - go-version: '^1.21.1' # The Go version to download (if necessary) and use. + go-version: '^1.23.1' # The Go version to download (if necessary) and use. - run: go version ``` @@ -98,14 +98,14 @@ steps: - uses: actions/checkout@v5 - uses: actions/setup-go@v6 with: - go-version: '>=1.20.0' + go-version: '>=1.22.0' - run: go version ``` > **Important**: Due to YAML parsing behavior, always wrap version numbers in single quotes: > ```yaml -> go-version: '1.20' # Correct -> go-version: 1.20 # Incorrect - YAML parser interprets as 1.2 +> go-version: '1.22' # Correct +> go-version: 1.22 # Incorrect - YAML parser interprets as 1.2 > ``` #### Pre-release Versions @@ -116,7 +116,7 @@ steps: - uses: actions/checkout@v5 - uses: actions/setup-go@v6 with: - go-version: '1.22.0-rc.1' # The Go version to download (if necessary) and use + go-version: '1.24.0-rc.1' # The Go version to download (if necessary) and use - run: go version ``` @@ -126,7 +126,7 @@ steps: - uses: actions/checkout@v5 - uses: actions/setup-go@v6 with: - go-version: '1.16.0-beta.1' # The Go version to download (if necessary) and use + go-version: '1.23.0-beta.1' # The Go version to download (if necessary) and use - run: go version ``` @@ -146,7 +146,7 @@ steps: **Previous Stable Release** -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. +If `oldstable` is provided, when current release is 1.23.x, action will resolve version as 1.22.x, where x is the latest patch release. ```yaml steps: - uses: actions/checkout@v5 @@ -199,7 +199,7 @@ steps: - uses: actions/checkout@v5 - uses: actions/setup-go@v6 with: - go-version: '1.21' + go-version: '1.23' check-latest: true # Always check for the latest patch release - run: go version ``` @@ -210,7 +210,7 @@ steps: ### Caching -Caching is enabled by default. The action automatically caches and restores Go modules and build outputs using toolkit/cache with minimal configuration. +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. Caching is enabled by default. The action automatically caches and restores Go modules and build outputs using toolkit/cache with minimal configuration. #### Automatic Caching @@ -221,7 +221,7 @@ steps: - uses: actions/checkout@v5 - uses: actions/setup-go@v6 with: - go-version: '1.21' + go-version: '1.23' # cache: true (default) - run: go run hello.go ``` @@ -240,7 +240,7 @@ steps: - uses: actions/checkout@v5 - uses: actions/setup-go@v6 with: - go-version: '1.17' + go-version: '1.23' check-latest: true cache-dependency-path: | subdir/go.sum @@ -254,7 +254,7 @@ steps: - uses: actions/checkout@v5 - uses: actions/setup-go@v6 with: - go-version: '1.17' + go-version: '1.23' cache-dependency-path: "**/*.sum" - run: go run hello.go ``` @@ -266,7 +266,7 @@ steps: - uses: actions/checkout@v5 - uses: actions/setup-go@v6 with: - go-version: '1.21' + go-version: '1.23' cache: false - run: go run hello.go ``` @@ -283,7 +283,7 @@ jobs: runs-on: ubuntu-latest strategy: matrix: - go-version: ['1.20', '1.21', '1.22'] + go-version: ['1.21', '1.22', '1.23'] steps: - uses: actions/checkout@v5 - uses: actions/setup-go@v6 @@ -298,11 +298,11 @@ jobs: | Syntax Type | Example | Description | |-------------|---------|-------------| -| Specific version | `1.21.5` | Exact version | -| Semantic range | `^1.21.0` | Compatible with 1.21.0 | -| Comparison operators | `>=1.20.0` | Version 1.20.0 or higher | -| Wildcards | `1.21.x` | Latest patch of 1.21 | -| Pre-release | `1.22.0-rc.1` | Release candidate | +| Specific version | `1.23.2` | Exact version | +| Semantic range | `^1.23.0` | Compatible with 1.23.0 | +| Comparison operators | `>=1.22.0` | Version 1.22.0 or higher | +| Wildcards | `1.23.x` | Latest patch of 1.23 | +| Pre-release | `1.24.0-rc.1` | Release candidate | | Aliases | `stable`, `oldstable` | Latest stable versions | For more information about semantic versioning, see the [semver documentation](https://semver.org/). @@ -313,7 +313,7 @@ For more information about semantic versioning, see the [semver documentation](h - uses: actions/setup-go@v6 with: # Version or version range of Go to use - go-version: '1.21' + go-version: '1.23' # Path to go.mod or go.work file go-version-file: 'go.mod' From c19264c4e0996018fc086d69668d42f9b12a9852 Mon Sep 17 00:00:00 2001 From: mahabaleshwars <147705296+mahabaleshwars@users.noreply.github.com> Date: Thu, 25 Sep 2025 10:38:46 +0530 Subject: [PATCH 9/9] documentation update --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index f08f51e..3b7d1ff 100644 --- a/README.md +++ b/README.md @@ -65,7 +65,7 @@ The action follows this resolution order: To change the default behavior, use the `check-latest` input. -> **Note**: The setup-go action uses executable binaries built by the Golang team. The action does not build Go from source code. +> **Note**: The setup-go action uses executable binaries built by the Golang team. The action does not build golang from source code. ## Usage @@ -134,7 +134,7 @@ steps: **Stable Release** -If `stable` is provided, action will get the latest stable version from the go-versions repository manifest. +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. ```yaml steps: - uses: actions/checkout@v5 @@ -210,7 +210,7 @@ steps: ### Caching -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. Caching is enabled by default. The action automatically caches and restores Go modules and build outputs using toolkit/cache with minimal configuration. +The action features integrated caching for Go modules and build outputs. Built on [toolkit/cache](https://github.com/actions/toolkit/tree/main/packages/cache), it simplifies the caching process by requiring fewer configuration options. The cache input is optional, and caching is turned on by default. #### Automatic Caching @@ -346,12 +346,12 @@ If that fails as well you can get a higher rate limit with generating a personal uses: actions/setup-go@v6 with: token: ${{ secrets.GH_DOTCOM_TOKEN }} - go-version: '1.18' + go-version: '1.23' ``` ### Offline Runners -For runners without github.com access, Go versions must be pre-cached in the runner's tool cache. See "Setting up the tool cache on self-hosted runners without internet access". +For runners without github.com access, Go versions must be pre-cached in 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)". ## Recommended Permissions