Code Monkey home page Code Monkey logo

releaz's Introduction

releaz

A tool for generate release note based on git log command

Install

npm i releaz

Usage

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

Here is git log documentation.

Related

License

MIT © LitoMore

releaz's People

Contributors

litomore avatar

Stargazers

avatar avatar avatar avatar avatar

Watchers

avatar avatar avatar

Forkers

obfan

releaz's Issues

How could I add some additional information for the output?

I want the output could be in this format:

## my-project

- Release: v1.1
- Rollback: v1.0

Release notes:
| e1baa19 | devin.chenyang | GT-1163 Upload TSV
| 75da1a1 | lianglkqq0210  | fixed workspace cache bug
| 70f6899 | lianglkqq0210  | fixed references cached bug
| 7fb82a2 | jiong.huang    | [CLI] Pack release-note tool to a package
| 3654fdc | lianglkqq0210  | added suc notification
 
Website: [https://xxd3vin.github.io/](https://xxd3vin.github.io/)

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.