Skip to content

chunjiegame-cpu/commit-digest

Repository files navigation

Commit Digest

CI Node License: MIT

Turn git history into maintainable release and weekly digest notes. commit-digest groups commits into breaking changes, features, fixes, docs, tests, maintenance, and other work.

It is designed for maintainers who need a quick draft before writing release notes, project updates, or sponsor reports.

Installation

npm install -g commit-digest

From source:

git clone https://github.com/chunjiegame-cpu/commit-digest.git
cd commit-digest
npm install
node bin/commit-digest.js --since "30 days ago"

Usage

commit-digest
commit-digest --since "7 days ago"
commit-digest --since 2026-05-01 --until 2026-05-31
commit-digest --limit 250 --out RELEASE-DRAFT.md
commit-digest --json

Sample Output

# Commit Digest

Generated from 18 commits.

## Highlights

- 4 feature commits are ready for release notes.
- 3 fixes landed.

## Features

- feat(cli): add JSON output (abc1234, Ada)

CLI Reference

Option Description
--since <date> Start date or git date expression. Defaults to 14 days ago.
--until <date> End date or git date expression.
--limit <n> Maximum commits to inspect. Defaults to 100.
--json Print machine-readable JSON.
-o, --out <file> Write Markdown output to a file.
-h, --help Show help.

Maintainer Workflow

Run this before a release, paste the generated digest into a release draft, then edit for user impact. It keeps mechanical commit sorting out of the maintainer's head.

Development

npm install
npm test
node bin/commit-digest.js --help

Known Limits

  • Categorization is based on commit subjects.
  • It does not replace human-written release notes.
  • The best output comes from consistent Conventional Commit-style messages.

License

MIT

About

Turn git history into maintainable release and weekly digest notes.

Topics

Resources

License

Contributing

Security policy

Stars

Watchers

Forks

Packages

 
 
 

Contributors