actions/setup-go
1
0
Fork 0
mirror of https://github.com/actions/setup-go.git synced 2026-02-05 15:08:25 +00:00
Code Issues Projects Releases Packages Wiki Activity

feat: add support for custom go-download-site input

Browse source 
This adds a new `go-download-site` input parameter that allows users to specify a custom base URL for downloading Go distributions. This is particularly useful for GitHub Enterprise Server (GHES) environments, corporate proxies, or air-gapped setups where direct access to github.com is restricted.

Changes:
- Added `go-download-site` input to `action.yml` (default: `https://github.com`)
- Updated `installer.ts` to replace the default GitHub URL with the provided custom site URL
- Updated `main.ts` to pass the input to the installer
- Added documentation in `README.md` with examples for Artifactory and GHES proxies

Resolves #296
This commit is contained in:
abdennour 2025-11-29 20:44:19 +00:00
parent 4dc6199c7b
commit 74a1f88c58
4 changed files with 91 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

72
README.md
View file

@ -381,8 +381,80 @@ For more information about semantic versioning, see the [semver documentation](h
# Architecture to install (auto-detected if not specified)
architecture: 'x64'
# Base URL for downloading Go distributions (default: https://github.com)
go-download-site: 'https://github.com'
## Using Custom Download Sites
For environments with restricted internet access or when using internal mirrors/proxies, you can configure the action to download Go distributions from a custom location using the `go-download-site` input.
### Use Cases
- **GitHub Enterprise Server** - Access Go distributions through your internal server
- **Corporate Proxies** - Route downloads through approved proxy servers
- **Artifact Repositories** - Use internal artifact management systems (Artifactory, Nexus, etc.)
- **Air-Gapped Environments** - Download from pre-populated internal mirrors
### Configuration
```yaml
steps:
- uses: actions/checkout@v5
- uses: actions/setup-go@v6
with:
go-version: '1.21'
go-download-site: 'https://internal-artifactory.company.com/github-proxy'
- run: go version
```
**How it works:**
The action will replace the default `https://github.com` base URL with your custom download site. For example:
- **Default URL:**
```
https://github.com/actions/go-versions/releases/download/1.21.13-10277905115/go-1.21.13-linux-x64.tar.gz
```
- **Custom URL (with `go-download-site: 'https://internal-artifactory.company.com/github-proxy'`):**
```
https://internal-artifactory.company.com/github-proxy/actions/go-versions/releases/download/1.21.13-10277905115/go-1.21.13-linux-x64.tar.gz
```
### Requirements
Your custom download site must:
1. Mirror the same directory structure as GitHub's go-versions repository
2. Host the pre-built Go distribution archives
3. Be accessible from your runners
### Example: Using with JFrog Artifactory
```yaml
steps:
- uses: actions/checkout@v5
- uses: actions/setup-go@v6
with:
go-version: '1.23'
go-download-site: 'https://artifactory.internal.company.com/artifactory/github-mirror'
- run: go version
```
### Example: Using with GitHub Enterprise Server Proxy
```yaml
steps:
- uses: actions/checkout@v5
- uses: actions/setup-go@v6
with:
go-version: '1.22'
go-download-site: 'https://ghes.company.com/github-com-proxy'
- run: go version
```
> **Note:** The `go-download-site` parameter only affects downloads from the go-versions repository. Direct downloads from go.dev (fallback mechanism) are not affected by this setting.
## Using setup-go on GHES
setup-go comes pre-installed on GHES when Actions is enabled. For dynamic Go version downloads, the action fetches distributions from the [go-versions repository](https://github.com/actions/go-versions/) on github.com (external to your appliance).