Skip to content

shyh26/shipnotes

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

shipnotes

Generate beautiful changelogs from git history. Conventional commits in, user-friendly release notes out.

What it does

You write conventional commits. shipnotes reads your git history and turns it into a clean, categorized changelog your users will actually read.

Quick start

pip install shipnotes
shipnotes generate

Example output

## v1.2.0 (2026-05-20)

### Features
- Add dark mode support
- Introduce export to CSV

### Bug Fixes
- Fix login redirect loop on Safari
- Handle empty search results gracefully

### Documentation
- Update API reference for v2 endpoints

Features

  • Conventional commit parsing — Auto-categorizes by type (feat, fix, docs, etc.)
  • Tag-aware — Scopes changelog to commits since last tag
  • Markdown output — Ready to paste into GitHub Releases
  • Custom categories — Map commit types to your own section names

Supported commit types

Prefix Category
feat: / feature: Features
fix: / bugfix: Bug Fixes
perf: Performance
refactor: Refactoring
docs: Documentation
test: Tests
chore: Chores
ci: CI/CD
style: Style

Tech stack

Python, Typer, Rich, Git

More tools

  • pingbot — dead-simple cron job monitor with Telegram alerts
  • envyzer — .env file validator and diff tool
  • tokenalyzer — AI coding token usage & cost analyzer

About

Generate beautiful changelogs from git history. Zero-config, markdown output.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors