mt-changelog

creates changelogs for git projects

mt-changelog

Creates simple changelogs from your git commits in markdown with links when viewed from github.

Usage: changelog [options]

  Options:

    -h, --help               output usage information
    -V, --version            output the version number
    -t, --title [title]      the title of the changelog (should probably be the new tag)
    -m, --message [message]  regex to match commit messages to be included in the changelog
    -o, --out [path]         file to write changelog to
    -s, --stdout             will prevent writing a file and print results to stdout

installation

$ npm install mt-changelog

Example

Command line

# ensure you have a semver tag in the past, and then...
$ changelog -t v2.1.0

Node

var changelog = require('mt-changelog');

options = {
  stdout: false,
  out: 'CHANGELOG.md',
  title: 'v1.2.3',
  message: /\[(added|removed|changed|fixed)\]/,
  formatter: require('mt-changelog/lib/formatters/basic')
};

// Returns a Promise
changelog(options)
  .catch(function(err) {
    // error handling
  });

Output:

The commit hash becomes a link to the commit when viewed on github.

v2.1.0 - Fri, 28 Mar 2014 05:54:33 GMT
--------------------------------------

[1685ade](../../1685ade) [added] some new stuff
[02aa80f](../../02aa80f) [fixed] busted things


v2.0.10 - Fri, 21 Mar 2014 02:31:10 GMT
---------------------------------------

[1685ade](../../1685ade) [removed] terrible apis
[02aa80f](../../02aa80f) [changed] default options for stuff

By default, it will look for commit messages with subjects that match:

  • [added] ...
  • [changed] ...
  • [fixed] ...
  • [removed] ...

But you can supply a regex with -m [message], for example:

$ changelog -m '\[a\]|\[c\]|[\f\]|\[r\]'

HomePage

https://github.com/mtscout6/mt-changelog#readme

Repository

https+https://github.com/mtscout6/mt-changelog


上一篇:eslint-plugin-sort-destructure-keys
下一篇:release-script

相关推荐

  • (独家!)webpack 5 changelog 全文翻译

    ★ webpack 团队于北京时间 10 月 12 日凌晨发布了 版本,本文译自 。此部分主要面向非插件开发的 webpack 使用者。 ” 简要说明 此版本重点关注以下内容: ...

    8 个月前
  • 解析 SMTP 协议

    SMTP 是属于应用层协议, 是基于 TCP 协议用于收发邮件的.我们常常需要在业务中使用邮件, 但是并没有对 smtp 协议有足够的了解, 我们下面就来全面地了解一下. smtp 服务器一般会开启 ...

    2 年前
  • 规范 commit 与 changelog 生成

    一个良好的提交习惯,绝对会为以后的代码维护带来不小的收益。 举个例子,某天你自己写的一个功能出问题了,找到代码被修改的地方,发现是一个同事修改了一行代码,这个时候你一脸懵逼,因为他既没有写注释,co...

    2 年前
  • xmpp-smtp-gw

    xmpp smtp gateway XMPP SMTP Gateway build status(https://secure.travisci.org/sessionbird/xmppsmtp...

    3 个月前
  • vue实现移动端H5页面截图【html2canvas、domtoimage】

    开发vue项目最近遇到需要截图实现页面分享,刚开始毫无头绪,H5页面如何实现截图,查阅一些资料,推荐html2canvas、domtoimage这两款组件,接下来演示一下这两款组件的使用。

    9 个月前
  • vamtiger-test-node-typescript-repository

    Test node typescript repository. VAMTIGER Test Node Typescript Repository Just another test reposi...

    6 个月前
  • vamtiger-serve-lambda

    A utility to serve aws lambda projects locally for integration testing. VAMTIGER Serve Lambda A ut...

    6 个月前
  • vamtiger-require

    A parameterised module loader. VAMTIGER Require A parameterised module loader. Installation VAMT...

    6 个月前
  • vamtiger-remove

    Remove a defined path. VAMTIGER Remove(https://github.com/vamtigerproject/vamtigerremove) Remove f...

    6 个月前
  • vamtiger-regex-period

    A Regular Expression to Match a Period Character. VAMTIGER Regex Period A regular expression(https...

    6 个月前

官方社区

扫码加入 JavaScript 社区