GithubHelp home page GithubHelp logo

oucem / git-changelog Goto Github PK

View Code? Open in Web Editor NEW

This project forked from lkdjiin/git-changelog

0.0 2.0 0.0 284 KB

Extends git with a `changelog` command to generate a changelog file from your Git logs.

License: MIT License

Ruby 100.00%

git-changelog's Introduction

git-changelog

Description

Git-changelog is a Ruby script that extends git with a changelog command. This is usefull to automate changelog files production. Git-changelog outputs in markdown or html format. If you want to generate a simple text file and don't use markdown it's ok too, as markdown is a human readable text file format.

Install

Put the file git-changelog somewhere in your PATH.

Usage

Output on console:

git changelog

Output in a file:

git changelog > changelog.markdown

Git-changelog accept an option --since. This is the same option as the one for git log command. Examples:

git changelog --since=2013-07-01
git changelog --since=10.days

To output in Html:

git changelog --html

All the above combined:

git changelog --html --since=2013-05-27 > changelog.html

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

License

MIT

Questions and/or Comments

Feel free to email Xavier Nayrac with any questions, or contact me on twitter.

git-changelog's People

Contributors

lkdjiin avatar

Watchers

James Cloos avatar oucem 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.