agentleFS
LinuxSuRenLinuxSuRen/my-dsh-skills/skills/github-ci-release/SKILL.md

github-ci-release

Skill2 starsChanged 39 days agoMITView on GitHub

GitHub 项目自动化门面:CI 与 Release 必须有对应 GitHub Actions(构建/测试/lint + tag 触发发布);Go 项目提供二进制与容器双轨分发(goreleaser 多平台 + 多架构镜像推 ghcr),同版本同源;所有发行的 CLI 二进制必须支持 version 子命令查看语义化版本号。

  • Reads credentials
  • Installs packages

The file

Files
SKILL.md

GitHub 项目 CI 与 Release 规范

核心原则:CI 与 Release 是仓库门面的一部分,不是可选项。访客判断项目可信度的第一眼就是:有没有绿的 CI 徽章、有没有像样的 Release。新仓库开工第一件事就是放 CI,首个版本发布前 release workflow 必须就位——不要打了 tag 才补。

1. CI(每个 GitHub 项目必备)

  • .github/workflows/ci.yml,最小覆盖:构建 + 测试 + lint,按技术栈选择(go build ./... && go test ./... + golangci-lint;tsc --noEmit + vitest;mvn/gradle 等)。
  • 触发:push(master/main)+ pull_request;用 concurrency 取消同分支排队,避免任务堆积。
  • 依赖缓存加速:actions/setup-go 自带模块缓存、setup-node 的 cache;无缓存的长任务再考虑手动缓存。
  • CI 与分支保护联动:master 保护规则要求 CI 通过才可合并(arch-dev-workflow 的分支保护条目),CI 不作为门槛等于没有 CI。
  • 用 dependabot 保持 actions 版本更新(本仓库实践:checkout/setup-go/golangci-lint-action/gh-release 定期升版)。
  • 不在本机跑的重型验证(docker build、E2E)尽量下沉 CI(arch-dev-workflow 验证策略)。

2. Release(tag 触发自动化)

  • .github/workflows/release.yml:打 v* tag 触发;构建产物 + 自动 release notes + 附加 checksums。
  • 版本号 vX.Y.Z 语义化;Release 发布后不可变(arch-dev-workflow:防篡改已发布产物,修问题发新版本而非覆盖)。
  • release notes 用 GitHub 自动生成(generate_release_notes: true)起步,重要版本手写要点。

3. Go 项目分发双轨(二进制 + 容器缺一不可)

二进制

  • goreleaser 一站式:多平台交叉编译 + 压缩包 + checksums + 自动上传 GitHub Release。
  • 平台矩阵:linux/darwin/windows × amd64/arm64(arm64 时代默认双架构,按用户群裁剪)。
  • 轻量补充:文档给出 go install github.com/<owner>/<repo>@latest;CLI 工具满足收录条件时进 hd-home(见 open-source-contribution)。

容器

  • 多阶段 Dockerfile:builder(golang)→ 运行时层(distroless/alpine/scratch),最终镜像只留二进制与必需文件。
  • 多架构:docker buildx,linux/amd64 + arm64;推 ghcr.io——GitHub 原生 registry,GITHUB_TOKEN + permissions: packages: write 即可,无需额外凭证。
  • tag 三层:latest、vX.Y.Z、vX.Y;镜像名 = 仓库名、命名空间 = 原始 owner(与 project-branding 一致:分发物在原始项目名下,不在 fork 名下)。
  • 静态编译(CGO_ENABLED=0)可让 scratch 镜像与交叉编译同时简化。

双轨同源

  • 二进制与镜像同一 tag、同一 commit 构建触发(版本单源,见 installer-bundle-design);禁止 tag 与镜像各自漂移。
  • README 安装章节写全三条路径:go install / Release 二进制 / 容器镜像,各附一行命令。

4. CLI 二进制的版本可见性

所有发行的命令行二进制必须支持 xx version 子命令查看版本号,且版本号必须是语义化版本(semver)。

  • version 子命令是硬要求——用户报障的第一句话就是"你什么版本",日志与 issue 模板也依赖它;--version 旗标建议同开(cobra 设 rootCmd.Version 一行即得)。
  • 语义化版本 vX.Y.Z[-prerelease](Go 生态带 v 前缀):major=不兼容变更、minor=新功能、patch=修复;预发布用 -rc.1/-beta.1 后缀。
  • 版本与 tag 严格同源:xx version 输出 = git tag = Release 名 = 容器镜像 tag = goreleaser 版本。禁止手写版本常量与 tag 各自漂移——发版只打 tag,版本号由构建注入。
  • Go 实现惯例:
    var version = "dev" // 构建时注入:-ldflags "-X main.version=v1.2.3"
    goreleaser 自动注入(ldflags: -X main.version={{.Version}});建议同时注入 commit 与构建日期,输出 v1.2.3 (abc1234, 2026-11-14) 便于排查。
  • 源码/开发构建显示 dev(或 v0.0.0-dev+<commit>),不冒充发布版;CI 里可加一步校验:打 tag 构建后 ./xx version 输出必须等于 tag。

5. 检查清单(新仓库/盘点旧仓库)

  1. CI workflow 存在且 PR 上真实跑(绿徽章)?
  2. 分支保护把 CI 设为合并门槛?
  3. release workflow 在首个 tag 前就位?
  4. Go 项目:goreleaser 配置 + 多阶段多架构镜像推 ghcr?
  5. 二进制与镜像同版本同源、checksums 齐全?
  6. README 安装章节三路齐全(go install/二进制/容器)?
  7. xx version 可用、输出语义化版本且与 tag 一致、构建注入而非手写常量?
  8. dependabat 覆盖 actions 版本?

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.