Changelog-it

Generates a changelog of Jira issues from your git history and, optionally, attach all issues to a release.

For example:

$ changelog-it --range origin/prod...origin/master --release --gmudd --summary "some summary..."

take a look on this file to check how it will looks like

You can also have it automatically post to slack!

How it works

The script looks for Jira issue keys, surrounded by square brackets (i.e. [DEV-123]), in the git commit logs. When it finds one, it associates that Jira issue ticket with that commit and adds it to the changelog.

Installation

npm install -g -S @falcucci/changelog-it

Configuration

You'll need to configure Jira before you can use this effectively. Create a file called changelog.config.js and put it at the root of your workspace directory; where you'll call the jira-changelog command from.

Here's a simple example with sample Jira API values:

module.exports = {
  jira: {
    api: {
      host: "yoursite.atlassian.net",
      username: "jirauser",
      password: "s00persecurePa55w0rdBr0"
    },
  }
}

To see all values suported, look at the changelog.config.js file at the root of this repo.

Usage

changelog-it --range origin/prod...origin/master --slack --release

Assuming you deploy from the prod branch, this will generate a changelog with all commits after the last production deploy to the current master version.

If you define sourceControl.defaultRange in your config, you can run the command with the --range flag:

changelog-it

Releases

You can automatically attach Jira issues to a release with the --release flag. For example, let's say we want to add all issues in the changelog to the "sprint-12" release:

changelog-it --range origin/prod...origin/master --release sprint-12

This will set the fixVersions of all issues to "sprint-12" in Jira.

Slack

You can also have the script automatically post to slack.

First, get an API token from Slack for your workspace: https://api.slack.com/tokens

Then add slack to your configuration file:

module.exports = {
  slack: {
    apiKey: 'asdlfkjasdoifuoiucvlkxjcvoixucvi',
    channel: '#changelogs'
  },
  jira: {
    api: {
      host: "myapp.atlassian.net",
      username: "jirauser",
      password: "s00persecurePa55w0rdBr0"
    },
  }
}

• Add your API token to slack.apiKey.
• slack.channel is the channel you want the script to send the changelog to.

Then simply add the --slack flag to the command:

changelog-it --range origin/prod...origin/master --slack

You can automate it generating semantic version tags using the following command:

curl -LsS https://raw.githubusercontent.com/falcucci/release-me/master/changelog-it.sh | bash -s <semantic-version> <summary>

or creating an alias in your .aliases file:

alias release-me='curl -LsS https://raw.githubusercontent.com/falcucci/release-me/master/changelog-it.sh | bash -s $1 $2'

and run:

release-me <semantic-version> <summary>

GitLab CI

note: this requires npm to run+

Store the following envs in GitLab CI variable.

| name | description | | ---- | ----------- | | GITLAB_API_KEY | Gitlab api key | | SLACK_API_KEY | Slack api key | | SLACK_CHANNELS | Slack channels ids separeted by comma | | GMUD_CHANNEL | Slack gmud channels ids separeted by comma |

.gitlab-ci.yml sample

changelog:
  script:
    - changelog-it v1.0.0...v2.0.0 --release --gmud
    # Or using aliases above if you have it in a package.json
    - npm run changelog
    # Or using some script
    - curl -LsS https://raw.githubusercontent.com/falcucci/release-me/master/ci-changelog-it.sh | bash -s

You can use changelog-it to generate changelogs and gmuds from anywhere with following environment variables.

$ export GITLAB_API_KEY=haya14busa
$ export SLACK_API_KEY=haya14busa
$ export SLACK_CHANNELS=APOISFDUP
$ export GMUD_CHANNEL=PAOISUFOPUAS

API

The code used to generate the changelogs can also be used as modules in your JavaScript. See the module source for documentation.

For example:

npm install -S @falcucci/changelog-it

const Config = require('@falcucci/changelog-it').Config;
const SourceControl = require('jira-changelog').SourceControl;
const Jira = require('jira-changelog').Jira;

const gitRepoPath = '/home/user/source/'

// Get configuration
const config = Config.getConfigForPath(gitRepoPath);

// Get commits for a range
const source = new SourceControl(config);
const range = {
  from: "origin/prod",
  to: "origin/master"
};
source.getCommitLogs(gitRepoPath, range).then((commitLogs) => {

  // Associate git commits with jira tickets and output changelog object
  const jira = new Jira(config);
  jira.generate(commitLogs).then((changelog) => {
    console.log(changelog);
  });

});