Skip to content

Latest commit

 

History

History
39 lines (29 loc) · 1021 Bytes

git-release-notes.md

File metadata and controls

39 lines (29 loc) · 1021 Bytes
Raw

git-release-notes

Generates simple markdown formatted release notes based on git history. This is a "dumb" listing with minimal filtering. It will remove merge commit messages while sorting and cleaning up the output slightly.

Usage

git release-notes START_COMMIT END_COMMIT

START_COMMIT The starting commit hash, branch, or tag to begin reviewing commits from. This can be any valid identifier, including HEAD or mybranch~15.

END_COMMIT The ending commit hash, branch, or tag to stop reviewing commits from.

Example

Without:

$ git log --oneline develop~4..develop
5f393e3 (develop) EXAM-5678: This is an example commit message.
c598933 Merge branch 'hotfix'
ed7d84c EXAM-1234: This is another example message.
5a1c5b5 This is a message that doesn't follow the pattern.

With:

$ git release-notes develop~4 develop
* EXAM-1234: This is another example message.
* EXAM-5678: This is an example commit message.
* This is a message that doesn't follow the pattern.