Giter Club home page Giter Club logo

release_notes's Introduction

Release Notes

I wrote a small Ruby script that generates simple release notes from a pair of git commits. All it does is spit out a list of git commit summaries sorted by author and a complete list of all files that have been added, modified, or deleted between the two versions.

Using it

Pretty simple.

ruby release_notes.rb commit1 commit2

Note that commit1 and commit2 can be any git-recognized commit identifier, meaning you can use branch names, raw commit hashes, tags, and so on.

Contirbuting

I could see this becoming a little more complex in the future. Right now it's just a script but it could eventually become a gem. I could see it potentially allowing for custom templates where the main power lay just in parsing various git output into friendly Ruby data structures for manipulation.

But that's all future-thinking for now.

release_notes's People

Contributors

tyler-eon avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.