构建发布说明 CLI

项目概述

本项目实现一个面向 release note generation 的完整系统，核心要解决的问题是 turning a range of conventional commits into grouped, human-readable release notes。整体由 Commit reader、Conventional parser、Group sorter、Breaking extractor、Note renderer 五个模块组成，每个模块单一职责、可独立测试，最后通过集成测试验证端到端正确性。设计上把 a commit with a malformed conventional header that is silently dropped and loses a change from the notes 作为第一类需求先行处理，而非事后再补。

架构与关键决策

数据模型为 a list of conventional commits parsed into type, scope, and subject, grouped by type with breaking changes called out first。Commit reader 定义其余阶段共同依赖的数据形状并在边界处校验输入；Conventional parser 承载 release note generation 的正确性逻辑；Group sorter 专门处理 a commit with a malformed conventional header that is silently dropped and loses a change from the notes，在失败路径上给出明确的拒绝、重试或降级策略；Breaking extractor 提供可观测性，每次操作输出带关联 id 的结构化事件；Note renderer 在过载时按既定方式降级，避免过载演变为数据损坏。配置与代码分离，使风险变更可经 diff 审阅。

实施与测试

按五个阶段依次实现 Commit reader、Conventional parser、Group sorter、Breaking extractor、Note renderer，每阶段配套聚焦单测。集成测试组合各模块并驱动真实 release note generation 场景：先验证正常路径，再刻意触发 a commit with a malformed conventional header that is silently dropped and loses a change from the notes 并断言系统降级而非损坏。所有依赖均在进程内或被桩替换，用例在 CI 中确定可复现。

限制与后续

• 单区域设计，多区域复制超出范围。
• Commit reader 默认进程内，未水平共享。
• 无鉴权层，假定部署在强制身份的边缘之后。

代码示例

# setup for release-notes-cli
pnpm init
pnpm add commander simple-git
pnpm add -D typescript tsx vitest

release_notes_cli/
├── src/index.ts
├── src/commit-reader.ts
├── src/conventional-parser.ts
├── tests/release_notes_cli.test.ts
└── package.json

// Commit reader: release note generation core
export function commitreader(input: CommitreaderInput): CommitreaderResult {
  // Build the commit reader that anchors release note generation and defines the core data shape.
  return processCommitreader(input);
}

// Conventional parser — handles release note generation Add the conventional parser so
export class Conventionalparser {
  constructor(private opts: ConventionalparserOptions) {}
  async run(ctx: Context): Promise<ConventionalparserOutput> {
    return this.execute(ctx);
  }
}

// Group sorter: release note generation stage
export const groupsorter = (next: Next) => async (req: Request) => {
  const out = await transform(req);
  return next(out);
};

// Breaking extractor for release note generation
export async function breakingextractor(stream: AsyncIterable<Chunk>): Promise<Aggregate> {
  let acc = init();
  for await (const c of stream) acc = merge(acc, c);
  return acc;
}

// Note renderer: release note generation finalization
export function noterenderer(state: State): Result {
  validate(state);
  return finalize(state);
}

# run the release note generation test suite
pnpm vitest run