Back to Details

app-store-changelog

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

App Store Changelog

App Store 变更日志

Overview

概述

Generate a comprehensive, user-facing changelog from git history since the last tag, then translate commits into clear App Store release notes.
根据自上一个标签以来的git历史生成全面的、面向用户的变更日志，随后将提交记录转化为清晰的App Store发布说明。

Workflow

工作流程

1) Collect changes

1) 收集变更

  • Run 
    scripts/collect_release_changes.sh
    from the repo root to gather commits and touched files.
  • If needed, pass a specific tag or ref: 
    scripts/collect_release_changes.sh v1.2.3 HEAD
    .
  • If no tags exist, the script falls back to full history.
  • 从仓库根目录运行
    scripts/collect_release_changes.sh
    以收集提交记录和被修改的文件。
  • 如有需要，可传入特定标签或引用：
    scripts/collect_release_changes.sh v1.2.3 HEAD
    。
  • 若不存在任何标签，脚本将回退为使用完整历史记录。

2) Triage for user impact

2) 筛选用户影响变更

  • Scan commits and files to identify user-visible changes.
  • Group changes by theme (New, Improved, Fixed) and deduplicate overlaps.
  • Drop internal-only work (build scripts, refactors, dependency bumps, CI).
  • 扫描提交记录和文件，识别用户可见的变更。
  • 按主题（新增、改进、修复）对变更进行分组，并去重重叠内容。
  • 剔除仅内部相关的工作（构建脚本、重构、依赖版本更新、CI相关内容）。

3) Draft App Store notes

3) 草拟App Store发布说明

  • Write short, benefit-focused bullets for each user-facing change.
  • Use clear verbs and plain language; avoid internal jargon.
  • Prefer 5 to 10 bullets unless the user requests a different length.
  • 为每个面向用户的变更撰写简短、聚焦收益的项目符号条目。
  • 使用清晰的动词和通俗易懂的语言；避免内部术语。
  • 除非用户要求不同长度，否则优先保留5至10个项目符号条目。

4) Validate

4) 验证

  • Ensure every bullet maps back to a real change in the range.
  • Check for duplicates and overly technical wording.
  • Ask for clarification if any change is ambiguous or possibly internal-only.
  • 确保每个项目符号条目都对应范围内的真实变更。
  • 检查是否存在重复内容和过于技术化的表述。
  • 若任何变更存在歧义或可能仅与内部相关，需请求澄清。

Output Format

输出格式

  • Title (optional): "What’s New" or product name + version.
  • Bullet list only; one sentence per bullet.
  • Stick to storefront limits if the user provides one.
  • 标题（可选）：“新增功能”或产品名称 + 版本号。
  • 仅使用项目符号列表；每个条目一句话。
  • 若用户提供了商店平台限制，请严格遵守。

Resources

资源

  • scripts/collect_release_changes.sh
    : Collect commits and touched files since last tag.
  • references/release-notes-guidelines.md
    : Language, filtering, and QA rules for App Store notes.
  • scripts/collect_release_changes.sh
    ：收集自上一个标签以来的提交记录和被修改的文件。
  • references/release-notes-guidelines.md
    ：App Store发布说明的语言规范、筛选规则和QA准则。