https://github.com/litomore/releaz

A tool for generate release note with `git log`
https://github.com/litomore/releaz

git-log release release-notes release-tool

Last synced: 20 days ago
JSON representation

A tool for generate release note with `git log`

• Host: GitHub
• URL: https://github.com/litomore/releaz
• Owner: LitoMore
• License: mit
• Created: 2018-04-27T07:47:07.000Z (over 6 years ago)
• Default Branch: main
• Last Pushed: 2023-06-10T00:54:34.000Z (over 1 year ago)
• Last Synced: 2024-10-14T01:11:36.435Z (25 days ago)
• Topics: git-log, release, release-notes, release-tool
• Language: TypeScript
• Homepage:
• Size: 225 KB
• Stars: 5
• Watchers: 4
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# releaz

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

[![](https://img.shields.io/npm/l/releaz.svg)](https://github.com/LitoMore/releaz/blob/main/LICENSE)

[![](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/xojs/xo)

A tool for generate release note based on `git log` command

## Install

```shell

npm i releaz

```

## Usage

```javascript

import releaz from 'releaz';

import chalk from 'chalk';

const result = await releaz({

	range: 'fa475e0..HEAD',

	format: `- ${chalk.cyan('%h')} ${chalk.blue('%an')} %s`,

});

console.log(result);

```

## API

### `releaz(options)`

#### Options

- **range**: Revision range

- **format**: [pretty formats](https://git-scm.com/docs/git-log#_pretty_formats) placeholders

> Here is `git log` [documentation](https://git-scm.com/docs/git-log).

## Related

- [releaz-cli](https://github.com/LitoMore/releaz-cli) - CLI for this module

- [execa](https://github.com/sindresorhus/execa) - A better `child_process`

## License

MIT © [LitoMore](https://github.com/LitoMore)