Ready to take your JavaScript development to the next level? Meet npm Enterprise - the ultimate in enterprise JavaScript. Learn more »

my-changelog

1.0.0 • Public • Published

my-changelog

A git log to CHANGELOG.md tool

npm npm

Eh?

my-changelog is a formalisation of the Node.js CHANGELOG.md entry process but flexible enough to be used on other repositories.

my-changelog will look at the git log of the current directory, pulling entries since the last tag. Commits with just a version number in the summary are removed, as are commits prior to, and including summaries that say working on <version> (this is an io.js / Node ism).

After collecting the list of commits, any that have PR-URL: <url> in them are looked up on Stash and the labels of the pull request are collected, specifically looking for labels that start with semver (the assumption is that semver-minor, semver-major labels are used to indicate non-patch version bumps).

Finally, the list is formatted as Markdown and printed to stdout.

Each commit will come out something like this (on one line):

* [[`20f8e7f17a`](https://stash.domain.com/projects/DEMO/repos/app/commits/20f8e7f17a)] - **test**: remove flaky test functionality (Rod Vagg)
* [[`f0e2aced96`](https://github.com/lestad/clinic/commit/f0e2aced96)] - **fix**: Hide "Hello" for small screens (Sergey Sova)

Note:

  • When running my-changelog on the command-line, the default Stash) repo is computed from the package.json that exists on cwd, otherwise fallback to nodejs/node, you can change this by supplying the user/org as the first argument and project as the second. e.g my-changelog joyent node.
  • Commit links will go to the assumed repo (default: nodejs/node)
  • If a commit summary starts with a word, followed by a :, this is treated as a special label and rendered in bold
  • Commits that have semver* labels on the pull request referred to in their PR-URL have those labels printed out at the start of the summary, in bold, upper cased.
  • Pull request URLs come from the PR-URL data, if it matches the assumed repo (default: nodejs/node) then just a # followed by the number, if another repo then a full user/project#number.

When printing to a console some special behaviours are invoked:

  • Commits with a summary that starts with doc: are rendered in grey
  • Commits that have a semver* label on the pull request referred to in their PR-URL are rendered in bold green

Install

$ npm i -g my-changelog

Usage

my-changelog [--simple] [--url=https://stash.domain.com/projects/NAME] [--group] [--start-ref=<ref>] [--end-ref=<ref>] [github-user[, github-project]]

  • github-user and github-project should point to the GitHub repository that can be used to find the PR-URL data if just an issue number is provided and will also impact how the PR-URL issue numbers are displayed
  • --quiet do not print to process.stdout
  • --url set default repo url. If --url was provided, simple commit path added to end
  • --all process all commits since beginning, instead of last tag.
  • --simple will print a simple form, without additional Markdown cruft
  • --group will reorder commits so that they are listed in groups where the xyz: prefix of the commit message defines the group. Commits are listed in original order within group.
  • --start-ref=<ref> will use the given git <ref> as a starting point rather than the last tag. The <ref> can be anything commit-ish including a commit sha, tag, branch name. If you specify a --start-ref argument the commit log will not be pruned so that version commits and working on <version> commits are left in the list.
  • --end-ref=<ref> will use the given git <ref> as a end-point rather than the now. The <ref> can be anything commit-ish including a commit sha, tag, branch name.
  • --filter-release: Exclude Node-style release commits from the list. e.g. Working on v1.0.0 or 2015-10-21 Version 2.0.0 and also npm version X style commits containing only an x.y.z semver designator.

License

changelog-maker is Copyright (c) 2015 Rod Vagg @rvagg and licenced under the MIT licence. All rights not explicitly granted in the MIT license are reserved. See the included LICENSE.md file for more details.

my-changelog is Copyright (c) 2016 Sergey Sova [LestaD] i.am@lestad.net

Keywords

none

install

npm i my-changelog

Downloadsweekly downloads

0

version

1.0.0

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability