https://github.com/truedat101/gitchanges

A bourne-shell script to help you easily generate simple Markdown Release Notes
https://github.com/truedat101/gitchanges

Last synced: 8 days ago
JSON representation

A bourne-shell script to help you easily generate simple Markdown Release Notes

• Host: GitHub
• URL: https://github.com/truedat101/gitchanges
• Owner: truedat101
• License: bsd-3-clause
• Created: 2014-06-14T22:49:21.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2014-06-14T23:50:58.000Z (over 10 years ago)
• Last Synced: 2024-12-08T05:26:36.459Z (15 days ago)
• Language: Shell
• Size: 137 KB
• Stars: 0
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
gitchanges

==========

A bourne-shell script to help you easily generate simple Markdown Release Notes

Overview

========

The purpose of this script is to generate a nicely formated Release Note output using simple markdown.  

The reason to do this is that git should, if your team is sensible, will write terse but detailed commit

messages on the first line, and leave the details for the other lines.  You can use this in your workflow

to generate release docs.

I tried a number of tools out there that claimed to generate nice release notes.  However they didn't work.

All that is really needed is some time spent reading git docs to process properly.

Usage

=====

gitchanges.sh <  First Tag  > <  Second Tag  > 

gitchanges.sh v0.3.0 v0.3.1

You can redirect output as necessary to generate text or consume as part of your doc release process.

Attributions

============

A nice little script that does what this script does, however, it had some bugs, and wasn't exactly suited to my workflow.

* http://www.sixmiletech.com/content/lazy-git-release-notes-drupal-projects