cyrilschumacher / unporter

Generate Markdown code from conventional commits for pull requests.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

unporter

MIT License npm version Node.js CI Coverage Status Known Vulnerabilities

Generate a Markdown file according to conventional Git commits.

unporter is a tool, developed in TypeScript and based on Node.js, generate a Markdown file according to conventional Git commits.

Getting Started

Usage

To install to using npm package manager:

npm install -g unporter

After installation, you can use the tool:

unporter <branch> 

Options

The tool provides several options:

  • -b, --branch <branch>

Defines the parent branch. The specified branch will be used with the current branch to determine the commits to retrieve. By default, the master branch is used.

  • -o, --output <file>

Defines the output file: the content generated by the tool will be redirected to this file.

  • --debug

Enables the debug mode.

License

This project is licensed under the MIT License - see the LICENSE file for details.

About

Generate Markdown code from conventional commits for pull requests.

License:MIT License


Languages

Language:TypeScript 97.8%Language:Mustache 1.9%Language:JavaScript 0.3%