https://github.com/kouhin/changelogit

A JavaScript-Library version of git-extras/git-changelog
https://github.com/kouhin/changelogit

changelog git github history

Last synced: about 2 months ago
JSON representation

A JavaScript-Library version of git-extras/git-changelog

• Host: GitHub
• URL: https://github.com/kouhin/changelogit
• Owner: kouhin
• License: mit
• Created: 2017-07-05T10:20:04.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2020-05-19T06:05:01.000Z (about 6 years ago)
• Last Synced: 2025-10-25T01:34:20.013Z (8 months ago)
• Topics: changelog, git, github, history
• Language: JavaScript
• Homepage:
• Size: 432 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Changelogit (Changelog for Git/Github)

A JavaScript-Library version of [git-extras/git-changelog](https://github.com/tj/git-extras/blob/master/bin/git-changelog)

[![npm](https://img.shields.io/npm/v/changelogit.svg)](https://www.npmjs.com/package/changelogit)

[![dependency status](https://david-dm.org/kouhin/changelogit.svg?style=flat-square)](https://david-dm.org/kouhin/changelogit)

[![airbnb style](https://img.shields.io/badge/code_style-airbnb-blue.svg)](https://github.com/airbnb/javascript)

## Installation

- npm

``` shell

npm install changelogit --save

```

## Usage

``` javascript

import changelogit from 'changelogit';

changelogit('v1.0.0', 'v2.0.0', {

  titleTag: 'n.n.n', // [default: n.n.n] Tag for untagged commits

  listAll: false, // [default: false] true: Retrieve all commits, false: Only untagged commits

  noMerges: false, // [default: false] true: Suppress commits from merged branches

  mergesOnly: false, // [default: false] true: Only uses merge commits

}).then((changelog) => {

  // Print changelog (in JSON)

  console.info(JSON.stringify(changelog, null, '  '));

});

```

## License

MIT