Add --include-branch option

Fixes #38

Author: cookpete

README.md

@@ -37,6 +37,7 @@ Options:
       --ignore-commit-pattern [regex] # pattern to ignore when parsing commits
       --starting-commit [hash]        # starting commit to use for changelog generation
       --tag-prefix [prefix]           # prefix used in version tags, default: v
+      --include-branch [branch]       # one or more branches to include commits from, comma separated
   -V, --version                       # output the version number
   -h, --help                          # output usage information
 

package.json

@@ -44,6 +44,7 @@
     "commander": "^2.9.0",
     "fs-extra": "^5.0.0",
     "handlebars": "^4.0.11",
+    "lodash.uniqby": "^4.7.0",
     "parse-github-url": "^1.0.1",
     "semver": "^5.1.0"
   },

src/commits.js

@@ -18,8 +18,9 @@ const MERGE_PATTERNS = [
   /Merge branch .+ into .+\n\n(.+)[\S\s]+See merge request [^!]*!(\d+)/ // GitLab merge
 ]
 
-export async function fetchCommits (remote, options) {
-  const log = await cmd(`git log --shortstat --pretty=format:${LOG_FORMAT}`)
+export async function fetchCommits (remote, options, branch = null) {
+  const command = branch ? `git log ${branch}` : 'git log'
+  const log = await cmd(`${command} --shortstat --pretty=format:${LOG_FORMAT}`)
   return parseCommits(log, remote, options)
 }
 

src/releases.js

@@ -38,6 +38,10 @@ export function parseReleases (commits, remote, latestVersion, options) {
   return releases
 }
 
+export function sortReleases (a, b) {
+  return a.tag && b.tag ? semver.rcompare(a.tag, b.tag) : 0
+}
+
 function newRelease (tag = null, date = new Date().toISOString()) {
   const release = {
     commits: [],

src/run.js

@@ -1,11 +1,12 @@
 import { Command } from 'commander'
 import { readJson, writeFile, pathExists } from 'fs-extra'
 import semver from 'semver'
+import uniqBy from 'lodash.uniqby'
 
 import { version } from '../package.json'
 import { fetchRemote } from './remote'
 import { fetchCommits } from './commits'
-import { parseReleases } from './releases'
+import { parseReleases, sortReleases } from './releases'
 import { compileTemplate } from './template'
 import { parseLimit } from './utils'
 
@@ -33,6 +34,7 @@ function getOptions (argv, pkg) {
     .option('--ignore-commit-pattern [regex]', `pattern to ignore when parsing commits`)
     .option('--starting-commit [hash]', `starting commit to use for changelog generation`)
     .option('--tag-prefix [prefix]', `prefix used in version tags`)
+    .option('--include-branch [branch]', `one or more branches to include commits from, comma separated`, str => str.split(','))
     .version(version)
     .parse(argv)
 
@@ -66,13 +68,27 @@ function getLatestVersion (options, pkg, commits) {
   return null
 }
 
+async function getReleases (commits, remote, latestVersion, options) {
+  let releases = parseReleases(commits, remote, latestVersion, options)
+  if (options.includeBranch) {
+    for (const branch of options.includeBranch) {
+      const commits = await fetchCommits(remote, options, branch)
+      releases = [
+        ...releases,
+        ...parseReleases(commits, remote, latestVersion, options)
+      ]
+    }
+  }
+  return uniqBy(releases, 'tag').sort(sortReleases)
+}
+
 export default async function run (argv) {
   const pkg = await pathExists('package.json') && await readJson('package.json')
   const options = getOptions(argv, pkg)
   const remote = await fetchRemote(options.remote)
   const commits = await fetchCommits(remote, options)
   const latestVersion = getLatestVersion(options, pkg, commits)
-  const releases = parseReleases(commits, remote, latestVersion, options)
+  const releases = await getReleases(commits, remote, latestVersion, options)
   const log = await compileTemplate(options.template, { releases })
   await writeFile(options.output, log)
   return `${Buffer.byteLength(log, 'utf8')} bytes written to ${options.output}`

test/run.js

@@ -140,6 +140,22 @@ describe('run', () => {
     return run(['', '', '--unreleased'])
   })
 
+  it('supports includeBranch option', () => {
+    mock('fetchCommits', (remote, options, branch) => {
+      if (branch === 'another-branch') {
+        return commits.concat({
+          date: '2015-12-15T12:03:09.000Z',
+          tag: 'v0.2.0'
+        })
+      }
+      return commits
+    })
+    mock('writeFile', (output, log) => {
+      expect(log).to.include('v0.2.0')
+    })
+    return run(['', '', '--include-branch', 'another-branch'])
+  })
+
   it('does not error when using latest version option', () => {
     return run(['', '', '--latest-version', '3.0.0'])
   })

yarn.lock

@@ -2188,6 +2188,10 @@ lodash.cond@^4.3.0:
   version "4.5.2"
   resolved "https://registry.yarnpkg.com/lodash.cond/-/lodash.cond-4.5.2.tgz#f471a1da486be60f6ab955d17115523dd1d255d5"
 
+lodash.uniqby@^4.7.0:
+  version "4.7.0"
+  resolved "https://registry.yarnpkg.com/lodash.uniqby/-/lodash.uniqby-4.7.0.tgz#d99c07a669e9e6d24e1362dfe266c67616af1302"
+
 lodash@^4.17.4, lodash@^4.2.0, lodash@^4.3.0:
   version "4.17.4"
   resolved "https://registry.yarnpkg.com/lodash/-/lodash-4.17.4.tgz#78203a4d1c328ae1d86dca6460e369b57f4055ae"