Skip to content

winnielinnie/release-note-diff-cli

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

release-note-diff-cli

release-note-diff-cli is a small Python CLI for diffing two release note files and surfacing the additions that are most likely to matter.

It is built for a very normal workflow: cloud and product release notes change just enough month to month that scanning them manually gets slow and noisy.

Quick run

python3 release_note_diff.py sample_old.txt sample_new.txt

Sample output:

Added: 2
Removed: 0
Important additions: 2

Important additions:
- Launched detached invocation support
- Fixed retry bug in function executor

What it looks for

  • lines added in the new release note file
  • lines removed from the old file
  • additions containing words like launch, fix, deprecated, limit, or support

The logic is deliberately simple. This is closer to a faster first pass than a full release note intelligence layer.

Good fit

  • monthly or weekly release note review
  • platform teams scanning for features, fixes, or breaking changes
  • PM or field work where you want a short summary before reading the full notes

Boundaries

  • plain text in, plain text out
  • line-based diffing only
  • no grouping by product area
  • no attempt to understand the importance of a change beyond keyword matches

Repo shape

  • release_note_diff.py contains the diff logic and CLI
  • sample_old.txt and sample_new.txt give you a quick local run
  • tests/test_release_note_diff.py covers the core addition and keyword-highlighting behavior

Related context

About

CLI that diffs release notes and highlights additions likely to matter.

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages