Go Proxy Cache Updater Action

Automatically pull new Go module releases to your specified proxy cache when tags are created. This ensures your module is immediately available and documentation is updated on platforms like pkg.go.dev.

Features

• Automatically triggers on new tag releases that match semantic version patterns
• Supports standard version tags (vX.Y.Z) and submodule version tags (submodule/path/vX.Y.Z)
• Customizable proxy configuration
• Custom import path support
• Simple to configure workflow

Usage

Basic Configuration

Create a new workflow file (e.g., .github/workflows/go-proxy-pull.yml) with the following content:

name: Go Proxy Cache Updater
on:
  release:
    types:
      - created

jobs:
  update-proxy-cache:
    name: Update Go Proxy Cache
    runs-on: ubuntu-latest
    steps:
      - name: Pull new module version
        uses: nicholas-fedor/go-proxy-pull-action@v1

This workflow will trigger whenever a new release is published with a tag matching vX.Y.Z or submodule/path/vX.Y.Z format.

Inputs

goproxy

URL of the Go proxy to use for pulling the new module version. Use this to specify a self-hosted proxy or alternative public proxy.

• Type: string
• Required: false
• Default: https://proxy.golang.org

Example: Custom Proxy

- name: Pull new module version
  uses: nicholas-fedor/go-proxy-pull-action@v1
  with:
    goproxy: https://gocenter.io

import_path

Custom import path for your module. Use this if your module uses a custom domain instead of the GitHub repository URL.

• Type: string
• Required: false
• Default: github.com/<user>/<repo>

Example: Custom Import Path

- name: Pull new module version
  uses: nicholas-fedor/go-proxy-pull-action@v1
  with:
    import_path: example.com/myproject

Supported Tag Formats

The action supports the following tag formats:

Standard Version Tags

• v1.0.0
• v2.1.3
• v1.0.0-beta.1 (pre-release versions)

Submodule Version Tags

• contrib/awesomity/v1.2.3
• internal/utils/v0.5.0

How It Works

1. The action triggers on new release creation
2. Extracts the version from the tag
3. Determines the module import path (using default or custom value)
4. Handles submodule paths from tags like submodule/path/vX.Y.Z
5. Adds major version suffix for modules with major version > 1 (e.g., /v2)
6. Uses go get to pull the new version to the configured proxy
7. Updates the proxy cache with the new module version

Why Use This Action?

While Go proxies typically pull modules on-demand, there are scenarios where proactive caching is beneficial:

• Documentation Updates: Ensures pkg.go.dev documentation is immediately available for new releases
• Reliability: Prevents proxy timeouts or failures when modules are first requested
• Performance: Reduces latency for initial module downloads
• Availability: Ensures your module is accessible from your proxy even if GitHub is experiencing issues

Configuration Example

Full Configuration with Custom Proxy and Import Path

name: Go Proxy Cache Updater
on:
  release:
    types:
      - created

jobs:
  update-proxy-cache:
    name: Update Go Proxy Cache
    runs-on: ubuntu-latest
    steps:
      - name: Pull new module version
        uses: nicholas-fedor/go-proxy-pull-action@v1
        with:
          goproxy: https://proxy.example.com
          import_path: example.com/myproject

License

This project is released under the MIT License.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.