app-store-changelog

📝 自动化 App Store 发布说明生成

由 dimillian 开发的纯只读工具,自动从 git 历史提取用户可见变更,生成符合 App Store 规范的发布说明,助力开发团队高效完成版本发布文档。

收藏
2.1k
安装
816
版本
v1.0.1
CLS 安全性认证2026-07-01
点击查看完整报告 >

使用说明

核心用法

App Store Changelog 是一款面向移动应用开发者的自动化文档生成工具。其核心工作流程分为四步:首先通过 scripts/collect_release_changes.sh 脚本收集自上次 git 标签以来的所有提交记录和变更文件;随后对提交进行筛选,识别真正影响用户体验的改动,剔除内部重构、CI 配置、依赖升级等无用户感知的内容;接着将有效变更按「新增」「优化」「修复」三类主题归类,并转化为简洁明了的利益导向型描述;最后输出符合 App Store 字符限制规范的 bullet list 格式发布说明。用户也可指定任意 git 引用范围(如 v1.2.3 HEAD)来生成特定区间的变更日志,若仓库无标签则自动回退至完整历史记录。

显著优点

该 Skill 的最大价值在于将繁琐的手动整理工作完全自动化。传统发布说明编写需要开发者逐条审阅 commit、判断用户相关性、统一措辞风格,耗时且易遗漏。此工具通过脚本化流程将耗时从数十分钟压缩至秒级,同时内置的 release-notes-guidelines.md 参考文档确保了输出质量的一致性。其纯只读设计意味着零副作用风险,可安全嵌入 CI/CD 流水线实现发布流程的完全自动化。此外,Bash 脚本采用 set -euo pipefail 严格模式,变量均经过引号保护,代码健壮性达到生产环境标准。

潜在缺点与局限性

功能边界较为明确也带来了一定局限:该工具仅适用于基于 git 标签管理的项目,对于未使用语义化版本标签或采用其他版本控制系统的团队无法直接使用。输出质量高度依赖团队提交规范——若 commit message 混乱或缺乏描述性,生成的发布说明同样需要人工润色。此外,脚本目前仅支持标准 git 命令,对 monorepo 多包场景或复杂分支策略(如频繁 cherry-pick)的变更归属判断可能不够精准。翻译和多语言支持未在文档中提及,国际化团队可能需要额外处理。

适合的目标群体

主要面向 iOS/Android 独立开发者、中小型移动应用团队的技术负责人,以及负责应用商店运营的产品经理。特别适合已建立规范 git 工作流、追求发布流程自动化的敏捷团队。对于需要频繁迭代、每周甚至每日提交版本审核的社交、工具类应用团队,该 Skill 能显著降低运营文案负担。开源项目维护者也可借此快速生成 GitHub Release 与 App Store 双平台的同步说明。

使用风险

性能方面,在超大型仓库(数十万提交)中全历史扫描可能产生短暂延迟,建议配合标签范围使用。依赖项风险极低,仅需系统预装的 bash、git、sed 三个标准组件,无第三方包管理器依赖。需注意脚本执行环境必须具备 git 可执行权限及仓库读取权限,容器化 CI 环境中应确认基础镜像包含 git。虽为只读操作,但仍建议在正式集成前于沙盒仓库验证输出格式是否符合预期,避免因提交规范差异导致发布说明遗漏关键特性。

安全解读

核心功能

app-store-changelog 是一款专为移动应用开发者设计的自动化工具,核心功能是将 Git 仓库的提交历史转化为符合 App Store 规范的「What’s New」发布说明。其工作流程清晰:首先通过 shell 脚本收集自上次标签以来的所有变更,然后智能过滤掉内部重构、CI 配置、依赖升级等对用户无感知的提交,最终将剩余的用户可见变更按「新增」「改进」「修复」三类主题归类,生成 5-10 条简洁有力的要点式说明。

显著优点

1. 开发者友好:由知名 iOS 开发者 Thomas Ricouard(dimillian)维护,拥有成熟开源项目背书,代码风格简洁规范
2. 零依赖风险:不依赖任何第三方包管理工具,仅使用系统标准 Git 命令,供应链攻击面为零

3. 纯本地运行:无网络请求、无外部 API 调用,所有数据处理在本地完成,隐私合规性极佳

4. 安全设计:仅执行只读操作(git loggit describe),无文件写入、进程创建或动态代码执行风险

5. 输出规范:自动遵循 App Store 的字数限制和语言风格,减少人工编辑成本

潜在局限

  • 适用范围有限:专为 Git 仓库设计,不适用于 SVN 等其他版本控制系统
  • 语义理解依赖提交规范:若团队提交信息混乱(如大量「fix bug」「update」等模糊描述),输出质量会下降
  • 无多语言支持:当前版本未内置本地化功能,需人工翻译为其他语言
  • 平台针对性:主要针对 iOS/macOS App Store 风格,Google Play 或 Steam 等平台需手动调整格式

适用人群

  • 独立 iOS/macOS 开发者希望自动化发布流程
  • 小型至中型移动应用团队,缺乏专职产品经理撰写更新日志
  • 追求敏捷发布的团队,需要快速从代码变更生成用户文档
  • 重视安全合规的企业环境,要求工具零外部依赖、可审计

常规风险提示

尽管该 skill 安全评级极高,用户仍需注意:

  • 输入验证:若手动指定 Git 引用范围(如 v1.2.3 HEAD),需确保引用格式正确,避免意外扫描整个仓库历史
  • 敏感信息泄露:虽然工具本身安全,但若 Git 历史中误提交了 API 密钥或个人信息,导出日志时可能暴露——这是 Git 使用问题,非本工具缺陷
  • 版本标签依赖:自动检测「上次标签」功能依赖团队规范使用 Git 标签,否则可能生成过大的变更集

app-store-changelog 内容

references文件夹
scripts文件夹
手动下载zip · 2.9 kB
release-notes-guidelines.mdtext/markdown
请选择文件