https://github.com/plantain-00/git-commits-to-changelog

A CLI to generate changelog from git commits.
https://github.com/plantain-00/git-commits-to-changelog

Last synced: 12 days ago
JSON representation

A CLI to generate changelog from git commits.

• Host: GitHub
• URL: https://github.com/plantain-00/git-commits-to-changelog
• Owner: plantain-00
• License: mit
• Created: 2020-07-11T08:52:16.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2022-12-02T23:30:56.000Z (almost 2 years ago)
• Last Synced: 2024-10-04T22:25:33.022Z (about 1 month ago)
• Language: TypeScript
• Size: 596 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# git-commits-to-changelog

A CLI to generate changelog from git commits.

[![Dependency Status](https://david-dm.org/plantain-00/git-commits-to-changelog.svg)](https://david-dm.org/plantain-00/git-commits-to-changelog)

[![devDependency Status](https://david-dm.org/plantain-00/git-commits-to-changelog/dev-status.svg)](https://david-dm.org/plantain-00/git-commits-to-changelog#info=devDependencies)

[![Build Status: Windows](https://ci.appveyor.com/api/projects/status/github/plantain-00/git-commits-to-changelog?branch=master&svg=true)](https://ci.appveyor.com/project/plantain-00/git-commits-to-changelog/branch/master)

![Github CI](https://github.com/plantain-00/git-commits-to-changelog/workflows/Github%20CI/badge.svg)

[![npm version](https://badge.fury.io/js/git-commits-to-changelog.svg)](https://badge.fury.io/js/git-commits-to-changelog)

[![Downloads](https://img.shields.io/npm/dm/git-commits-to-changelog.svg)](https://www.npmjs.com/package/git-commits-to-changelog)

[![type-coverage](https://img.shields.io/badge/dynamic/json.svg?label=type-coverage&prefix=%E2%89%A5&suffix=%&query=$.typeCoverage.atLeast&uri=https%3A%2F%2Fraw.githubusercontent.com%2Fplantain-00%2Fgit-commits-to-changelog%2Fmaster%2Fpackage.json)](https://github.com/plantain-00/git-commits-to-changelog)

## install

`yarn global add git-commits-to-changelog`

## usage

run `git-commits-to-changelog`

## options

key | description

--- | ---

-h,--help | Print this message.

-v,--version | Print the version

--release | release version, eg `--release 1.0.0`

--append | append changelog to old changelog rather than generate it from whole git commits

## API

```ts

import { gitCommitToChangeLog } from 'git-commits-to-changelog'

const changelog = await gitCommitToChangeLog()

```