AgentSkillsCN

git-publish-release

当用户明确要求“将项目发布至 GitHub”、“创建 GitHub Release”或“生成 Release Notes”时使用。智能分析 tag 间的历史变化,生成专业且引人入胜的 Release Notes,自动创建 GitHub Release。支持首次发布、常规版本、预发布版本(alpha/beta/rc),自动识别 prerelease 标记。

SKILL.md
--- frontmatter
name: git-publish-release
description: 当用户明确要求"发布项目到 GitHub"、"创建 GitHub Release"或"生成 Release Notes"时使用。智能分析 tag 间历史变化,生成专业且吸引人的 Release Notes,自动创建 GitHub Release。支持首次发布、常规版本、预发布版本(alpha/beta/rc),自动识别 prerelease 标记。

metadata:
  short-description: GitHub Release 自动发布与 Release Notes 生成
  keywords:
    - git-publish-release
    - GitHub Release
    - release notes
    - version publish

GitHub Release

智能分析项目历史变化,自动生成吸引人的 Release Notes 并发布到 GitHub。

触发条件

用户需要:

  • 发布项目的新版本到 GitHub
  • 创建 GitHub Release 并自动生成 Release Notes
  • 推送某个 tag 到 GitHub 并创建 release
  • 总结版本间的历史变化

你需要确认的输入

  1. 目标 tag(如 v3.0.0
    • 如未指定,列出最近 tags 供选择
  2. 项目路径(可选,默认当前工作目录)
  3. GitHub Token
    • 自动从当前目录的 .env 文件读取 GH_TOKEN
    • .env 不存在,自动创建并提示用户添加 token
    • 自动将 .env 添加到 .gitignore(如未添加)

工作流程

准备认证

首先获取 GitHub Token:

bash
# 确保 .env 存在、.gitignore 已配置,并读取 GH_TOKEN
GH_TOKEN=$(bash scripts/get-github-token.sh)

脚本会自动处理:

  • .env 文件不存在时自动创建
  • .env 未在 .gitignore 中时自动添加
  • 读取并返回 GH_TOKEN

确认项目信息

与用户确认后,获取项目基本信息:

bash
# 从 git remote 获取 owner/repo
REPO=$(git config --get remote.origin.url | sed -E 's|.*github.com[/:]([^/]+)/([^/]+)\.git|\1/\2|')

支持的 remote 格式:

  • HTTPS: https://github.com/owner/repo.git
  • SSH: git@github.com:owner/repo.git

获取最新 Release 信息

使用 GitHub API 获取最新发布的 release:

bash
curl -s -H "Authorization: token $GH_TOKEN" \
  "https://api.github.com/repos/$REPO/releases" | \
  jq -r '.[0] | {tag_name, published_at}'
  • 如果存在历史 release,比较范围为:PREVIOUS_TAG..TARGET_TAG
  • 如果是首个 release,比较范围为:从初始 commit 到 TARGET_TAG

分析历史变化

获取两个版本之间的 commit 历史:

bash
# 如果有历史 release
git log ${PREVIOUS_TAG}..${TARGET_TAG} --pretty=format:"%h|%s|%an|%ad" --date=short

# 如果是首个 release
git log ${TARGET_TAG} --pretty=format:"%h|%s|%an|%ad" --date=short

生成 Release Notes

根据 commit 历史和项目特点,智能生成 Release Notes。

Release Notes 结构

code
🎉 [版本号] - [吸引人的标题]
[一句话总结本次发布的核心价值/意义]

🚀 核心亮点:
• [亮点1]
• [亮点2]
• [亮点3]

✨ 主要更新:
[类别1]
• 更新内容1
• 更新内容2

[类别2]
• 更新内容3
• 更新内容4

🔧 技术改进:
• 技术改进1
• 技术改进2

📋 完整变更日志:
[简略说明获取方式或列出主要 commits]

标题撰写原则

  • 情感化表达:使用"革命性"、"突破性"、"里程碑"等词汇
  • 场景化描述:说明这个版本解决什么问题、带来什么价值
  • 时效性关联:如"为 2026 年就绪"、"拥抱新范式"

内容分类原则

根据 commit 信息自动分类:

类别图标类别名称Commit 关键词示例
🚀核心亮点breakthrough, major, feature
新功能add, new, feature
🐛Bug 修复fix, bugfix, resolve
🔧技术改进refactor, optimize, improve
📝文档更新docs, readme, guide
🔐安全更新security, fix vulnerability
💥破坏性变更breaking, deprecate

语言风格

  • 简洁有力:每个要点不超过一行
  • 价值导向:强调"为什么"而非仅仅"是什么"
  • 用户视角:用用户能理解的语言,避免技术术语堆砌
  • 适当煽动:使用感叹号、emoji 营造氛围,但不过度

判断是否为 Prerelease

根据 tag 名称自动判断:

  • 包含 alpha, beta, rc, pre 等标识 → prerelease: true
  • 否则 → prerelease: false

创建 GitHub Release

使用 GitHub API 创建 release:

bash
curl -X POST \
  -H "Authorization: token $GH_TOKEN" \
  -H "Accept: application/vnd.github.v3+json" \
  "https://api.github.com/repos/$REPO/releases" \
  -d "{
    \"tag_name\": \"$TARGET_TAG\",
    \"name\": \"$TARGET_TAG\",
    \"body\": \"$RELEASE_NOTES\",
    \"draft\": false,
    \"prerelease\": $PRERELEASE
  }"

输出格式

完成发布后,向用户输出:

code
✅ Release 发布成功!

📍 Release URL: [release 链接]
🏷️ Tag: [tag 名称]
📅 发布时间: [时间]

📝 Release Notes 预览:
[生成的前 10 行 notes]

参考资源

错误处理

场景处理方式
.env 文件不存在自动创建并提示用户添加 GH_TOKEN
GH_TOKEN 未设置或无效提示用户在 .env 文件中设置 token
Tag 不存在提示用户可用的 tags 列表
网络请求失败重试 3 次,仍失败则报错并给出手动创建指南
权限不足提示检查 token 权限(需要 repo scope)
Release 已存在询问用户是否覆盖(更新现有 release)

实现注意事项

  1. 跨平台兼容:始终使用正斜杠 / 处理路径
  2. 错误解决:捕获 curl 错误并给出明确的错误信息
  3. Git 远程解析:处理 HTTPS 和 SSH 两种 remote URL 格式
  4. Markdown 转义:在 JSON 中传递 Release Notes 时正确处理特殊字符
  5. Token 安全.env 文件自动加入 .gitignore,防止意外提交