Jung von Matt/Neckar - GroundZero Changelog

What is this script doing?

Bumps the release version depending on the type of commits found and writes all the commits to a changelog file in Markdown format.

How is it doing it?

1. Gets the last release tag from the package.json and scans all commits from the git HEAD to that point.
2. From the commits determines what type of release it should be and bumps the package.
3. Formats the commits to markdown and writes to CHANGELOG.md

Installation

1. npm install:

   npm install @jvmn/groundzero-changelog --save-dev
   

2. add a script to the scripts section in your package.json

   "postrelease": "groundzero-changelog",

   or any other hook you want to run it from.

3. *optionally run standalone nextSteps log via:

   "groundzero-changelog-next"

4. *optionally overwrite default options in package.json

Options

In your main project package.json you can overwrite some defaults by adding the jvmChangelog object. Defaults to:

"jvmChangelog": {
    "logNextSteps": "true",
    "pathChangelog": "./docs/CHANGELOG.md",
    "pathRepo": "./.git",
    "gitRepo": "false",
    "gitPlatform": "bitbucket",
    "ignores": ["build", "chore", "revert", "test"],
    "extraComments": []
},

The gitRepo url used to generate Bitbucket/ Github links. Fractal config is not used anymore.

gitPlatform responsible for the url format outputed on commits and version compare, by default uses "bitbucket" but now supports also "github".

extraComments accepts an array with strings and generates extra comment lists automaticly (which you would fill manually) and prints them before the commit groups in each relase.

logNextSteps if set to false will not print the next steps log at the end of the task. Instead one can run it at a later date via the node command "groundzero-changelog-next"

Script assumptions

• Your commits follow the Angular Commit Message Conventions (https://gist.github.com/stephenparish/9941e89d80e2bc58a153)

• A Jira ticket is written inside brackets [TICKET-123] and can be located anywhere in the commit.