Skip to content

Generate release notes based on Github pull request title from given two git-refs

Notifications You must be signed in to change notification settings

chernjie/github-release-notes

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

32 Commits
 
 
 
 
 
 

Repository files navigation

Generate Changelog or Release Notes

Generate release notes based on Github pull request title from given two git-refs

Usage:

release-notes.sh [<commit-ish>] [<lasttagname>]

release-notes.sh --release <tagname>

release-notes.sh --draft <tagname>

Options:

-l, --list list tags sorted by creatordate

-h, --help print this help

<commit-ish> Commit-ish object names, branch or tagname represents the end of revision range. Defaults to HEAD

<lasttagname> represents the beginning of revision range. Defaults to last <tagname>

Example:

  release-notes.sh

  [Changeset](../../compare/<lasttagname>...<commit-ish>)
  * #9 Use short ref instead of HEAD in changelog message
  * #8 support other git remote standards for determining API endpoint
  * #4 Update changelog message
  * #3 If no variable is provided, default to the last tag
  * #2 Add support for using tags as GIT_START_REF

Example to create a Github Release tag

git tag $tagname
git push --tags
release-notes.sh --release $tagname

Dependencies:

GitHub command-line tool

an extension to command-line git that helps you do everyday GitHub tasks without ever leaving the terminal.

Alternatives

Automatically generated release notes

About

Generate release notes based on Github pull request title from given two git-refs

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages