Bug fix and library updates

• #28 Fixed range parsing bug the occurs when one part of the range has a dot in it. (thanks @ndecapite)
• #26, #29 Bumped versions of lodash and browserlist

v2.1.0

New JIRA config property (jira.api.options) used to set additional options on the JIRA client (jira-client docs). Thanks @EugenEistrachKC!

Git range fix + enhancements

Improvements

• New hideEmptyBlocks config option to cleanup empty sections in the output. Thanks @dmitryuk (#20)

Bug fixes

• Fix failure due to missing JIRA reporter field or slack API configuration. Thanks @sketchings (#22)
• Fix git commit range parsing to support double and triple dots (.. vs `...) correctly.

Breaking changes

If you were previously using three dots in your commit range (e9f569df...cd1f7cd6), it will now return more commits than you likely expect. This is because the previous parser treated triple dots as if they were double dots (read about the difference). To fix this, use 2 dots in your range instead (e9f569df..cd1f7cd6).

If you were simply using the defaultRange value in the config file, nothing should change. If you want that range to be symmetric, you can now set symmetric:true in the defaultRange object (for example).

Fix AllHtmlEntities error

For some reason, the 1.2.1 version of html-entities was suddenly failing. This version does an upgrade to that and other libraries and fixed a couple failing tests.

Disable symmetric comparison

More info: #14

Version 1.6.0 - Less noise, more signal

The goal of this release was to remove a lot of unneeded noise from the changelogs. These involve some changes in functionality, please read.

Changes

• Upgrade core libraries to remove security warnings (core-js, lodash, babel, etc)
• Rollup merge commits into a single entry.
• Detect revert commits
• Add unit test coverage.
• Cleaned up a lot of code.

Detect Reverts

Previously, if you reverted a commit tagged with a Jira ticket, that ticket will still show up in the changelog even though it's no longer there. This is because the git commit would be something like: "Revert [ENG-123] lorem ipsum".

Now, as long as you use the default git revert commit message, jira-changelog will remove those reverted commits from the changelog. It will also intelligently detect a revert of a revert, which reincludes the ticket in the changelog as well as a revert, of a revert, of a revert, and so on.

Rollup Merge Commits

When merging a branch without squashing the commits first, all the commits from that branch will also be added to the git logs; which can cause a lot of noise in the changelog.

Now jira-changelog will attempt to rollup all those commits into the single merge commit. NOTE: This will still use the commit messages for all those commits to detect which tickets were included, but only a single commit will be presented in the changelog.

How it works

Every git log has a "parents" value, which is a list of git commit shas. The first value is the commit which came before this one. If there is more than one parent, it signals a merge and each git commit sha is one of the revisions merged into this. We can use that and then walk backward, to determine all the commits included with a merge.

Version 1.5.0

Jira has deprecated authenticating APIs with username and password. Now API requests need to be authenticated with the user's email address and Auth token.

How to upgrade

• Login to Jira with the user used by the jira-changelog script.
• Follow these instructions to get an auth token.
• Update your configuration file:
  • Change username to email and replace the value with the user's login email address.
  • Change password to token and the auth token to it.

Before

module.exports = {
  jira: {
    api: {
      host: 'myapp.atlassian.net',
      username: 'jirauser',
      password: 'pa55word'
    },
  }
}

After

module.exports = {
  jira: {
    api: {
      host: 'myapp.atlassian.net',
      email: '[email protected]',
      token: 'qWoJBdlEp6pJy15fc9tGpsOOR2L5i35v'
    },
  }
}

Add support for Jira releases

• Added support for the --release flag. (thanks @adwitz)
• Has proven stable enough for the 1.0.0 version number.