upgrading-golang

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Upgrading Golang Version

升级Golang版本

This skill automates the comprehensive Go version upgrade process across all components of the Chainloop project.
本Skill可自动完成Chainloop项目所有组件的Go版本全面升级流程。

Process

流程

1. Confirm Target Versions

1. 确认目标版本

Ask the user:
  1. What Go version they want to upgrade to (e.g., "1.25.3")
  2. Whether they also want to upgrade Atlas migrations Docker image (if yes, ask for target Atlas version, e.g., "0.38.0")
询问用户:
  1. 他们想要升级到的Go版本(例如:"1.25.3")
  2. 是否同时升级Atlas迁移Docker镜像(如果是,询问目标Atlas版本,例如:"0.38.0")

2. Get Docker Image Digest

2. 获取Docker镜像摘要

Pull the official golang Docker image and extract its SHA256 digest:
bash
docker pull golang:X.XX.X
Extract the SHA256 digest from the output (format:
sha256:abc123...
).
拉取官方golang Docker镜像并提取其SHA256摘要:
bash
docker pull golang:X.XX.X
从输出中提取SHA256摘要(格式:
sha256:abc123...
)。

3. Update Source Code

3. 更新源代码

Update the
go
directive in:
  • ./go.mod
IMPORTANT: Do NOT update
./extras/dagger/go.mod
per project policy.
Pattern to replace:
go
go X.XX.X
更新以下文件中的
go
指令:
  • ./go.mod
重要提示:根据项目策略,请勿更新
./extras/dagger/go.mod
需要替换的模式:
go
go X.XX.X

4. Update Docker Images

4. 更新Docker镜像

Update all Dockerfiles with the new version and SHA256 digest. See files-to-update.md for the complete list.
Pattern to replace:
dockerfile
FROM golang:X.XX.X@sha256:OLD_DIGEST AS builder
With:
dockerfile
FROM golang:X.XX.X@sha256:NEW_DIGEST AS builder
使用新版本和SHA256摘要更新所有Dockerfile。完整列表请查看files-to-update.md
需要替换的模式:
dockerfile
FROM golang:X.XX.X@sha256:OLD_DIGEST AS builder
替换为:
dockerfile
FROM golang:X.XX.X@sha256:NEW_DIGEST AS builder

5. Update GitHub Actions

5. 更新GitHub Actions

Update
go-version
in all workflow YAML files. See files-to-update.md for the complete list.
Pattern to replace:
yaml
go-version: "X.XX.X"
更新所有工作流YAML文件中的
go-version
。完整列表请查看files-to-update.md
需要替换的模式:
yaml
go-version: "X.XX.X"

6. Update Documentation

6. 更新文档

Update the version reference in
./CLAUDE.md
under "Key Technologies":
markdown
- **Language**: Go X.XX.X. To know how to upgrade go version, see docs/runbooks
更新
./CLAUDE.md
中“关键技术”部分的版本引用:
markdown
- **语言**:Go X.XX.X。如需了解如何升级Go版本,请查看docs/runbooks

7. Update Atlas Docker Image and CLI (Optional)

7. 更新Atlas Docker镜像和CLI(可选)

If the user requested an Atlas upgrade:
7a. Pull the Atlas Docker image and extract its SHA256 digest:
bash
docker pull arigaio/atlas:X.XX.X
Extract the SHA256 digest from the output (format:
sha256:abc123...
).
7b. Update
./app/controlplane/Dockerfile.migrations
:
Pattern to replace:
dockerfile
undefined
如果用户要求升级Atlas:
7a. 拉取Atlas Docker镜像并提取其SHA256摘要:
bash
docker pull arigaio/atlas:X.XX.X
从输出中提取SHA256摘要(格式:
sha256:abc123...
)。
7b. 更新
./app/controlplane/Dockerfile.migrations
需要替换的模式:
dockerfile
undefined

from: arigaio/atlas:X.XX.X

from: arigaio/atlas:X.XX.X

docker run arigaio/atlas@sha256:OLD_DIGEST version

docker run arigaio/atlas@sha256:OLD_DIGEST version

atlas version vX.XX.X

atlas version vX.XX.X

FROM arigaio/atlas@sha256:OLD_DIGEST as base

With:
```dockerfile
FROM arigaio/atlas@sha256:OLD_DIGEST as base

替换为:
```dockerfile

from: arigaio/atlas:X.XX.X

from: arigaio/atlas:X.XX.X

docker run arigaio/atlas@sha256:NEW_DIGEST version

docker run arigaio/atlas@sha256:NEW_DIGEST version

atlas version vX.XX.X

atlas version vX.XX.X

FROM arigaio/atlas@sha256:NEW_DIGEST as base

**7c. Update `./common.mk` for `make init`:**

**IMPORTANT**: Before updating the version in common.mk, ALWAYS test that the Atlas version is available via the curl command:

```bash
curl -sSf https://atlasgo.sh | ATLAS_VERSION=vX.XX.X sh -s -- --version
If the command fails or the version is not available, do NOT update common.mk. Only the Docker image should be updated in this case.
Update the Atlas CLI installation version in the
init
target:
Pattern to replace:
makefile
curl -sSf https://atlasgo.sh | ATLAS_VERSION=vX.XX.X sh -s -- -y
With the new version (note: use
v
prefix for the version):
makefile
curl -sSf https://atlasgo.sh | ATLAS_VERSION=vX.XX.X sh -s -- -y
FROM arigaio/atlas@sha256:NEW_DIGEST as base

**7c. 更新`./common.mk`中的`make init`:**

**重要提示**:在更新common.mk中的版本之前,务必通过curl命令测试该Atlas版本是否可用:

```bash
curl -sSf https://atlasgo.sh | ATLAS_VERSION=vX.XX.X sh -s -- --version
如果命令失败或版本不可用,请不要更新common.mk。在这种情况下,仅需更新Docker镜像。
更新
init
目标中的Atlas CLI安装版本:
需要替换的模式:
makefile
curl -sSf https://atlasgo.sh | ATLAS_VERSION=vX.XX.X sh -s -- -y
替换为新版本(注意:版本需使用
v
前缀):
makefile
curl -sSf https://atlasgo.sh | ATLAS_VERSION=vX.XX.X sh -s -- -y

8. Verify Changes

8. 验证更改

Run verification commands:
bash
make test
make lint
If errors occur, address them before completing the upgrade.
运行验证命令:
bash
make test
make lint
如果出现错误,请在完成升级前解决这些问题。

9. Final Checks

9. 最终检查

  • Ensure all license headers are updated (2024 → 2024-2025 or add current year)
  • Run
    buf format -w
    if any proto files were affected
  • Run
    wire ./...
    if any constructor dependencies changed
  • Verify
    go.mod
    changes with
    go mod tidy
  • 确保所有许可证头已更新(2024 → 2024-2025或添加当前年份)
  • 如果有proto文件受影响,运行
    buf format -w
  • 如果构造函数依赖项发生变化,运行
    wire ./...
  • 使用
    go mod tidy
    验证
    go.mod
    的更改

Important Notes

重要说明

  • Always use SHA256 digests for Docker images for security and reproducibility
  • The dagger module (
    ./extras/dagger/go.mod
    ) must NOT be updated
  • Test thoroughly as Go upgrades can introduce breaking changes
  • Multiple components use Go: CLI, Control Plane, and Artifact CAS
  • 为了安全性和可重复性,Docker镜像始终使用SHA256摘要
  • dagger模块(
    ./extras/dagger/go.mod
    )禁止更新
  • 由于Go升级可能会引入破坏性变更,请务必进行全面测试
  • 多个组件使用Go:CLI、控制平面和Artifact CAS