阅读中文版本

Build a Release Notes CLI

Release Notes CLI — a complete walkthrough of release note generation, covering commit reader, conventional parser, group sorter, and testing.

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);
}

Project overview

This project builds a release note generation system whose reason for existing is turning a range of conventional commits into grouped, human-readable release notes. The temptation in release note generation is to bolt the interesting part onto a working prototype and discover the hard cases in production; this build inverts that order and treats a commit with a malformed conventional header that is silently dropped and loses a change from the notes as the first thing designed, not the last.

You will implement Commit reader, Conventional parser, Group sorter, Breaking extractor, and Note renderer, each as a module with one responsibility and a test that proves it in isolation. The release note generation pipeline is then the wiring that composes them, and the integration test is where the composition is shown to survive a commit with a malformed conventional header that is silently dropped and loses a change from the notes.

The walkthrough is written for a developer who has used a release note generation system but has not had to make one honest. It favors explicit data shapes over clever abstractions, and it names the failure each design choice prevents rather than presenting the choice as a style preference.

Each phase ends with something observable — a commit reader that returns the right shape, a conventional parser that rejects bad input, an integration test that goes green — so you can stop at any point and still have a release note generation system that works for the cases covered so far.

What you will build

The finished release note generation system exposes five capabilities, each with a focused test:

• Commit reader
• Conventional parser
• Group sorter
• Breaking extractor
• Note renderer

Commit reader is the foundation that every later stage assumes; Conventional parser is where release note generation correctness lives; Group sorter handles a commit with a malformed conventional header that is silently dropped and loses a change from the notes; Breaking extractor makes the system observable; and Note renderer is the graceful-degradation layer that keeps overload from becoming corruption.

The build keeps the release note generation logic in ordinary modules you can read in one sitting, and pulls in dependencies only for the parts that are genuinely tedious to hand-roll. That keeps the diff between the tutorial and a real codebase small, and keeps the failure modes visible in code rather than hidden behind a framework.

Architecture and data model

The system is organized around Commit reader, Conventional parser, and Group sorter, with Breaking extractor tying them together. Data flows as a list of conventional commits parsed into type, scope, and subject, grouped by type with breaking changes called out first.

Each component is a module with a pure interface where practical: the same input produces the same output, and side effects are pushed to the edges. That discipline is what makes the phases independently testable, because a test for Group sorter does not need to stand up Commit reader and Conventional parser to exercise the interesting branch.

The data model is deliberately explicit. A list of conventional commits parsed into type, scope, and subject, grouped by type with breaking changes called out first Keeping the shape written down — in a schema, a type, or a fixture — means a change to the shape is a visible diff rather than a silent runtime shift, and it means the integration test can assert against a concrete shape instead of guessing.

Configuration and code are kept apart: the configuration says what release note generation should do, the modules say how. A reviewer can change a threshold or a policy without reading the implementation, which keeps the risky changes small and lets the diff stand as the review.

The failure path through Group sorter is designed before the happy path is finished, because a commit with a malformed conventional header that is silently dropped and loses a change from the notes is the case that distinguishes a release note generation system from a demo. Every component declares what it does when its inputs are wrong, and the integration test asserts each of those declarations.

Prerequisites and dependencies

Have these ready before you install anything, so the release note generation setup is not blocked by a missing tool:

• Node.js 20 LTS or later
• Familiarity with release note generation fundamentals
• A local environment to run the test suite

The runtime dependencies are chosen to keep the release note generation datapath legible:

• commander (^12.1.0) — CLI framework
• simple-git (^3.27.0) — Git log access

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

Versions are pinned to a major range so the release note generation install is reproducible; commit the lockfile. The commit reader reads its operational parameters from the environment and validates them at startup, so a missing value fails the boot rather than the first release note generation request.

Directory structure

Keep each release note generation component in its own file so it can be tested without starting the others:

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

Phase 1: Commit reader

Build the commit reader that anchors release note generation and defines the core data shape.

// 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);
}

After this phase the commit reader works in isolation and is covered by a unit test. The commit reader defines the data shape that every later stage assumes, so getting it right first means the later phases compile against a stable contract.

Treat the commit reader as the single source of truth for the release note generation data shape. Validate inputs at the boundary and reject early, so a malformed value never reaches Conventional parser or Group sorter where its effect would be harder to localize.

Phase 2: Conventional parser

Add the conventional parser so release note generation can turning a range of correctly.

// 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);
  }
}

After this phase the conventional parser works in isolation and is covered by a unit test. This is where release note generation correctness lives: the conventional parser is what makes turning a range of conventional commits into grouped, human-readable release notes true, and its test is the proof.

Keep the conventional parser pure where you can. A function that takes an input and returns an output is trivial to test and impossible to mock wrong; a class with hidden state is the opposite. Push side effects to the caller and keep the conventional parser about the transformation.

Phase 3: Group sorter

Wire the group sorter to handle a commit with a without losing data.

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

After this phase the group sorter works in isolation and is covered by a unit test. The group sorter is the difference between a release note generation system that works on the happy path and one that survives a commit with a malformed conventional header that is silently dropped and loses a change from the notes.

Design the failure before the success. Decide what group sorter does when a commit with a malformed conventional header that is silently dropped and loses a change from the notes: reject, retry, shed, or degrade — and write that test first. A release note generation system whose failure behavior is unspecified will pick one at random under pressure, and it is usually the wrong one.

Phase 4: Breaking extractor

Integrate the breaking extractor to make release note generation observable and testable end to end.

// 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;
}

After this phase the breaking extractor works in isolation and is covered by a unit test. Observability is not a finishing touch; it is how you know the release note generation system is doing what it claims in production.

Emit one structured event per meaningful action, with enough context to localize a failure without a second round-trip. The breaking extractor is what turns “something is slow” into “the conventional parser is slow for inputs matching this shape,” which is the difference between an alert and an investigation.

Phase 5: Note renderer

Finalize the note renderer so the release note generation system degrades gracefully under overload.

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

After this phase the note renderer works in isolation and is covered by a unit test. The note renderer is what keeps overload from becoming corruption: when the release note generation system is asked for more than it can do, it degrades in a defined way instead of failing in an undefined one.

Pick a degradation strategy for note renderer — shed, queue, or backpressure — and make it explicit in code and in a test. Leaving the behavior to chance is how a release note generation traffic spike becomes a data loss incident.

Testing

Each phase has a focused test: commit reader, conventional parser, and group sorter are exercised in isolation, then an integration test drives the full release note generation pipeline and asserts the a commit with a case is handled.

Start with unit tests that pin each component’s contract: the commit reader returns the documented shape, the conventional parser transforms correctly, and the group sorter fails in the documented way. These tests are fast and they localize regressions to the component that broke.

Then add an integration test that composes the components and drives a realistic release note generation scenario end to end. Assert the happy path first, then deliberately trigger a commit with a malformed conventional header that is silently dropped and loses a change from the notes and assert the system degrades rather than corrupts. Because the components are pure where practical, the integration test stays deterministic rather than flaky.

A release note generation suite must also prove the negative: bad input is rejected at the boundary, overload is shed rather than queued indefinitely, and a partial failure does not leave the system in an inconsistent state. These are the tests that catch the regressions a happy-path suite never would.

The entire release note generation suite runs with no external service; every dependency is either in-process or stubbed, so every case is reproducible in CI. That is what lets the group sorter failure-mode assertions live as tests rather than as a manual checklist that drifts out of date.

# run the release note generation test suite
pnpm vitest run

Deployment and operations

Run at least two release note generation instances behind a load balancer and share state in Redis. Set resource limits so release note generation overload surfaces as backpressure rather than failure.

Run at least two stateless instances behind a load balancer, and move any shared state into a shared store so the release note generation behavior is global rather than per instance. Size limits so the system sheds load before it runs out of memory, because a release note generation system that OOMs under load fails in a way that is hard to reason about.

Drain on deploy: stop accepting new work, let in-flight release note generation operations finish, then exit. Because the system holds no state that cannot be reconstructed, a rollout is a matter of cycling instances one at a time while watching the error rate.

When a dependency is unavailable, decide explicitly whether the release note generation system fails closed or degrades. Leaving that choice to chance is how a dependency outage becomes a silent data loss, so make the choice visible in code and in a test.

Security considerations

Validate all release note generation inputs at the boundary, reject oversized payloads before buffering them, and keep secrets in the environment rather than the repository.

The release note generation system is a choke point, so it is the right place to reject malformed input before it reaches conventional parser or group sorter. Validate the shape and the size at the edge, and let the inner components assume what they receive is well-formed.

Never log secrets or full payloads; log enough to localize a failure without recording data that should not be on disk. Treat any external call as untrusted and validate its response before using it, because a release note generation system that trusts its inputs blindly is one malformed response away from corruption.

Keep dependencies pinned and run an audit in CI. A transitive dependency with a known vulnerability is still a vulnerability in your release note generation system, and the lockfile is what makes the audit meaningful.

Observability

Emit one structured event per release note generation operation with the inputs’ shape, the outcome, and a correlation id. Track error rate and latency per component and alert on a step change rather than a single spike.

The correlation id is the thread that ties a user-visible symptom to the release note generation decision and to the component log entry for the same operation. Without it, an investigation starts from a timestamp and a guess.

Watch the group sorter failure rate separately from the overall error rate. A jump in group sorter failures usually means a commit with a malformed conventional header that is silently dropped and loses a change from the notes, not a bug in conventional parser, and the two have different owners and different fixes.

Chart the share of release note generation operations that shed, queue, or succeed. A change in the mix points at the cause faster than an aggregate latency can, because each class has a different root.

Troubleshooting

A commit with a malformed conventional header that is silently dropped and loses a change from the notes. Reproduce with a minimal fixture, then add a guard test so the release note generation system rejects the condition loudly.

Performance regresses under release note generation load. Profile with the sampling analyzer, locate the hot path in conventional parser, and add a targeted benchmark to lock the regression.

Keep the release note generation dashboards separate from dependency dashboards. When an operation fails, the correlation id lets you decide in seconds whether the fault is commit reader, conventional parser, or group sorter, instead of guessing from a timeout.

Limitations and next steps

• Single-region; multi-region replication is out of scope.
• The commit reader is in-process and not horizontally shared by default.
• No auth layer; assume deployment behind an edge that enforces identity.

The release note generation system is single-region by design; extending to multi-region means making commit reader shareable across regions, which is a real change to the consistency model rather than a config flag. The group sorter is in-process, which is correct for one instance but must move to a shared store before scaling out.

There is no authentication or authorization layer; the system assumes it is deployed behind an edge that enforces identity. Adding one is straightforward but out of scope for this build, and doing it here would distract from the release note generation correctness that is the point.

The natural next step, once the release note generation pipeline is trusted in production, is to add a short-TTL cache for idempotent reads and a richer breaking extractor that exports histograms rather than counters. Both are additive and neither changes the contracts this build establishes.