Giter VIP home page Giter VIP logo

clgt's Introduction

CLGT

Build Status Coverage Status Stable Version Download Status License

Change Log Git Tool

A tool generate git changelog file. It help you generate change logs for specific version, from version to version. Allow ignore some commits you don't like included in logs. History with markdown output.

Installation

npm install -g clgt

Usage

$ clgt --help

Change Log GiT
A tool generate changelog file.
Usage: clgt <option>

Options:
  -d, --description  Description  [string]
  -f, --file         File ouput  [string] [default: "CHANGELOG.md"]
  -n, --name         App Name  [string]
  -t, --tag          Tag revision git  [string]
  -u, --url          Url commit repository git  [string] [required]
  -h, --help         Show this help
  -r, --report       Export the report

FAQ

  1. How do I generate changelog to other file name?

    Answer: clgt -n othername.md

  2. How do I generate changelog for a specific version?

    Answer: clgt -t v1.0

  3. How do I generate changelog from a version to an other one?

    Answer: clgt -t v1.0..v2.0 will generate logs from after v1.0 to v2.0: logs without v1.0, include v2.0 and between them.

  4. How do I generate changelog from a version to now?

    Answer: clgt -t v1.0..

  5. I want to ignore some commits in change logs.

    Answer: Please add regex pattern in ignore field to configuration file.

  6. Where is the configuration file?

    Answer: It's .clgtrc, located at root repository.

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.