Refactor git data fetching logic

- Use `git tags` and then an individual `git log` for each release

Breaking changes:
- Removes `--starting-commit` option
	- Commits are no longer fetched in one long list, so this option no longer makes any sense
- Removes `--include-branch` option
	- No longer necessary now that releases are fetched via `git tags`

Author: cookpete

.travis.yml

@@ -10,9 +10,9 @@ cache:
 script:
   - npm run lint
   - npm run lint-markdown
-  - npm run test
+  - npm run test-coverage
 after_success:
-  - npm run coverage
+  - npm run report-coverage
 env:
   global:
     secure: F80ocIyMwaljpsWzLXRhoXTxR7kkYE0V9rTpAzO7MI/OmQ2UiAeQkyTXdthK6tZuz1oVVrpjDtYuJ0hmvlTBm7WmVWNK0S6kYhHsHGy1sRmwilBqVSwSFEcjjKmOAJckfIHwOG8tjWLY9qemrf9KqpvPCG7DiG4Pn+YHLOZT7XlXbBiec/qCnaskwBpN5KhA+VAhupcZEQAy5AWW5h+CU7NF60a4chlX4gmWjAgeHZlYr472pNRi+kDZVztaXusTEWExJog/NZ/Oi8VTZkzX0t3uNiWmLfRyYC1S8blq/jaPRuwtJrgzZZRRHZswN01cmBl/D8HAzvgrA24k/70QpNdjFeJ4s5PW9+4GiGnky5z5F3tB8Hlv0ofNQAR3IKAnI+lXy/DfSD10ZJls4bQMEdoPdG/34E5EGliG2WmP6chuTh8vPlZtOGMesUi0TkXSoYPO5njZEV0Ketye37LHTfwO4sf6OC0tV8MsTtLjqMU+081K20ACHITwaJlpfWP1uGLJn+zUx3XsGS8z7abt9+a9cPl9p917IpDttLsdtLhvGC988uWvJQ5F6UMlayf1MYavwmz0vKldDu3eHBKJSaTDqugwvivww3TxdG7Jw/mNVYsrdWz4Hr49QuugGxiOrL5ZtEIbBV50W0sPFe4XFXGFyjN2x/8/td3ZXL8glN4=

README.md

@@ -40,9 +40,7 @@ Options:
       --ignore-commit-pattern [regex] # pattern to ignore when parsing commits
       --tag-pattern [regex]           # override regex pattern for release tags
       --tag-prefix [prefix]           # prefix used in version tags, default: v
-      --starting-commit [hash]        # starting commit to use for changelog generation
       --sort-commits [property]       # sort commits by property [relevance, date, date-desc], default: relevance
-      --include-branch [branch]       # one or more branches to include commits from, comma separated
       --release-summary               # display tagged commit message body as release summary
       --handlebars-setup [file]       # handlebars setup file
       --append-git-log [string]       # string to append to git log command
@@ -118,7 +116,7 @@ auto-changelog --compare-url https://example.com/repo/compare/{from}...{to}
 
 #### Configuration
 
-You can set any option in `package.json` under the `auto-changelog` key, using camelCase options. Note that `includeBranch` should be an array here, not a comma separated list:
+You can set any option in `package.json` under the `auto-changelog` key, using camelCase options.
 
 ```js
 {
@@ -131,11 +129,7 @@ You can set any option in `package.json` under the `auto-changelog` key, using c
     "output": "HISTORY.md",
     "template": "keepachangelog",
     "unreleased": true,
-    "commitLimit": false,
-    "includeBranch": [
-      "release-v2",
-      "release-v3"
-    ]
+    "commitLimit": false
   }
 }
 ```

package.json

@@ -6,12 +6,16 @@
   "bin": {
     "auto-changelog": "./lib/index.js"
   },
+  "engines" : {
+    "node" : ">=7.6"
+  },
   "scripts": {
     "lint": "standard --verbose | snazzy",
     "lint-fix": "standard --fix",
     "lint-markdown": "markdownlint README.md test/data/*.md",
-    "test": "cross-env NODE_ENV=test nyc mocha test",
-    "coverage": "nyc report --reporter=json && codecov -f coverage/coverage-final.json",
+    "test": "cross-env NODE_ENV=test mocha -r @babel/register test",
+    "test-coverage": "cross-env NODE_ENV=test nyc mocha test",
+    "report-coverage": "nyc report --reporter=json && codecov -f coverage/coverage-final.json",
     "clean": "rimraf lib coverage",
     "build": "babel src -d lib",
     "preversion": "npm run lint && npm run test",
@@ -111,5 +115,8 @@
       "text",
       "html"
     ]
+  },
+  "auto-changelog": {
+    "breakingPattern": "Breaking change"
   }
 }

src/commits.js

@@ -1,9 +1,9 @@
 import semver from 'semver'
 import { cmd, isLink, encodeHTML, replaceText, getGitVersion } from './utils'
 
-const COMMIT_SEPARATOR = '__AUTO_CHANGELOG_COMMIT_SEPARATOR__'
-const MESSAGE_SEPARATOR = '__AUTO_CHANGELOG_MESSAGE_SEPARATOR__'
-const MATCH_COMMIT = /(.*)\n(?:\s\((.*)\))?\n(.*)\n(.*)\n(.*)\n([\S\s]+)/
+export const COMMIT_SEPARATOR = '__AUTO_CHANGELOG_COMMIT_SEPARATOR__'
+export const MESSAGE_SEPARATOR = '__AUTO_CHANGELOG_MESSAGE_SEPARATOR__'
+const MATCH_COMMIT = /(.*)\n(.*)\n(.*)\n(.*)\n([\S\s]+)/
 const MATCH_STATS = /(\d+) files? changed(?:, (\d+) insertions?...)?(?:, (\d+) deletions?...)?/
 const BODY_FORMAT = '%B'
 const FALLBACK_BODY_FORMAT = '%s%n%n%b'
@@ -18,38 +18,27 @@ const MERGE_PATTERNS = [
   /Merge branch .+ into .+\n\n(.+)[\S\s]+See merge request [^!]*!(\d+)/ // GitLab merge
 ]
 
-export async function fetchCommits (remote, options, branch = null, onProgress) {
-  const command = branch ? `git log ${branch}` : 'git log'
+export async function fetchCommits (diff, remote, options = {}) {
   const format = await getLogFormat()
-  const log = await cmd(`${command} --shortstat --pretty=format:${format} ${options.appendGitLog}`, onProgress)
+  const log = await cmd(`git log ${diff} --shortstat --pretty=format:${format} ${options.appendGitLog}`)
   return parseCommits(log, remote, options)
 }
 
 async function getLogFormat () {
   const gitVersion = await getGitVersion()
   const bodyFormat = gitVersion && semver.gte(gitVersion, '1.7.2') ? BODY_FORMAT : FALLBACK_BODY_FORMAT
-  return `${COMMIT_SEPARATOR}%H%n%d%n%ai%n%an%n%ae%n${bodyFormat}${MESSAGE_SEPARATOR}`
+  return `${COMMIT_SEPARATOR}%H%n%ai%n%an%n%ae%n${bodyFormat}${MESSAGE_SEPARATOR}`
 }
 
 function parseCommits (string, remote, options = {}) {
-  const commits = string
+  return string
     .split(COMMIT_SEPARATOR)
     .slice(1)
     .map(commit => parseCommit(commit, remote, options))
-
-  if (options.startingCommit) {
-    const index = commits.findIndex(c => c.hash.indexOf(options.startingCommit) === 0)
-    if (index === -1) {
-      throw new Error(`Starting commit ${options.startingCommit} was not found`)
-    }
-    return commits.slice(0, index + 1)
-  }
-
-  return commits
 }
 
-function parseCommit (commit, remote, options = {}) {
-  const [, hash, refs, date, author, email, tail] = commit.match(MATCH_COMMIT)
+export function parseCommit (commit, remote, options = {}) {
+  const [, hash, date, author, email, tail] = commit.match(MATCH_COMMIT)
   const [body, stats] = tail.split(MESSAGE_SEPARATOR)
   const message = encodeHTML(body)
   const parsed = {
@@ -58,40 +47,19 @@ function parseCommit (commit, remote, options = {}) {
     author,
     email,
     date: new Date(date).toISOString(),
-    tag: getTag(refs, options),
     subject: replaceText(getSubject(message), options),
     message: message.trim(),
     fixes: getFixes(message, author, remote, options),
     href: remote.getCommitLink(hash),
     breaking: !!options.breakingPattern && new RegExp(options.breakingPattern).test(message),
-    ...getStats(stats.trim())
+    ...getStats(stats)
   }
   return {
     ...parsed,
     merge: getMerge(parsed, message, remote, options)
   }
 }
 
-function getTag (refs, options) {
-  if (!refs) return null
-  for (const ref of refs.split(', ')) {
-    const prefix = `tag: ${options.tagPrefix}`
-    if (ref.indexOf(prefix) === 0) {
-      const tag = ref.replace(prefix, '')
-      if (options.tagPattern) {
-        if (new RegExp(options.tagPattern).test(tag)) {
-          return tag
-        }
-        return null
-      }
-      if (semver.valid(tag)) {
-        return tag
-      }
-    }
-  }
-  return null
-}
-
 function getSubject (message) {
   if (!message) {
     return '_No commit message_'
@@ -100,7 +68,7 @@ function getSubject (message) {
 }
 
 function getStats (stats) {
-  if (!stats) return {}
+  if (!stats.trim()) return {}
   const [, files, insertions, deletions] = stats.match(MATCH_STATS)
   return {
     files: parseInt(files || 0),

src/releases.js

@@ -1,92 +1,57 @@
 import semver from 'semver'
+import { fetchCommits } from './commits'
 import { niceDate } from './utils'
 
 const MERGE_COMMIT_PATTERN = /^Merge (remote-tracking )?branch '.+'/
 const COMMIT_MESSAGE_PATTERN = /\n+([\S\s]+)/
 
-function commitReducer ({ map, version }, commit) {
-  const currentVersion = commit.tag || version
-  const commits = map[currentVersion] || []
+async function createRelease (tag, previousTag, diff, remote, options) {
+  const commits = await fetchCommits(diff, remote, options)
+  const merges = commits.filter(commit => commit.merge).map(commit => commit.merge)
+  const fixes = commits.filter(commit => commit.fixes).map(commit => ({ fixes: commit.fixes, commit }))
+  const emptyRelease = merges.length === 0 && fixes.length === 0
+  const { date, message } = commits[0] || { date: new Date().toISOString() }
+  const breakingCount = commits.filter(c => c.breaking).length
+  const filteredCommits = commits
+    .filter(commit => filterCommit(commit, options, merges))
+    .sort(commitSorter(options))
+    .slice(0, getCommitLimit(options, emptyRelease, breakingCount))
   return {
-    map: {
-      ...map,
-      [currentVersion]: [...commits, commit]
-    },
-    version: currentVersion
+    tag,
+    title: tag || 'Unreleased',
+    date,
+    isoDate: date.slice(0, 10),
+    niceDate: niceDate(date),
+    commits: filteredCommits,
+    merges,
+    fixes,
+    summary: getSummary(message, options),
+    major: Boolean(!options.tagPattern && tag && previousTag && semver.diff(tag, previousTag) === 'major'),
+    href: getCompareLink(previousTag, tag, remote, options)
   }
 }
 
-export function parseReleases (commits, remote, latestVersion, options) {
-  const { map } = commits.reduce(commitReducer, { map: {}, version: latestVersion })
-  return Object.keys(map).map((key, index, versions) => {
-    const commits = map[key]
-    const previousVersion = versions[index + 1] || null
-    const versionCommit = commits.find(commit => commit.tag) || {}
-    const merges = commits.filter(commit => commit.merge).map(commit => commit.merge)
-    const fixes = commits.filter(commit => commit.fixes).map(commit => ({ fixes: commit.fixes, commit }))
-    const tag = versionCommit.tag || latestVersion
-    const date = versionCommit.date || new Date().toISOString()
-    const filteredCommits = commits
-      .filter(commit => filterCommit(commit, options, merges))
-      .sort(commitSorter(options))
-    const emptyRelease = merges.length === 0 && fixes.length === 0
-    const { tagPattern, tagPrefix } = options
-    return {
-      tag,
-      title: tag || 'Unreleased',
-      date,
-      isoDate: date.slice(0, 10),
-      niceDate: niceDate(date),
-      commits: sliceCommits(filteredCommits, options, emptyRelease),
-      merges,
-      fixes,
-      summary: getSummary(versionCommit.message, options),
-      major: Boolean(!tagPattern && tag && previousVersion && semver.diff(tag, previousVersion) === 'major'),
-      href: previousVersion ? remote.getCompareLink(`${tagPrefix}${previousVersion}`, tag ? `${tagPrefix}${tag}` : 'HEAD') : null
-    }
-  }).filter(release => {
-    return options.unreleased ? true : release.tag
+export function parseReleases (tags, remote, latestVersion, options) {
+  const releases = tags.map((tag, index, tags) => {
+    const previousTag = tags[index + 1]
+    const diff = previousTag ? `${previousTag}..${tag}` : tag
+    return createRelease(tag, previousTag, diff, remote, options)
   })
-}
-
-export function sortReleases (a, b) {
-  const tags = {
-    a: inferSemver(a.tag),
-    b: inferSemver(b.tag)
-  }
-  if (tags.a && tags.b) {
-    if (semver.valid(tags.a) && semver.valid(tags.b)) {
-      return semver.rcompare(tags.a, tags.b)
-    }
-    if (tags.a === tags.b) {
-      return 0
-    }
-    return tags.a < tags.b ? 1 : -1
-  }
-  if (tags.a) return 1
-  if (tags.b) return -1
-  return 0
-}
-
-function inferSemver (tag) {
-  if (/^v?\d+$/.test(tag)) {
-    // v1 becomes v1.0.0
-    return `${tag}.0.0`
+  if (latestVersion || options.unreleased) {
+    const tag = latestVersion || null
+    const previousTag = tags[0]
+    const diff = `${previousTag}..`
+    releases.unshift(createRelease(tag, previousTag, diff, remote, options))
   }
-  if (/^v?\d+\.\d+$/.test(tag)) {
-    // v1.0 becomes v1.0.0
-    return `${tag}.0`
-  }
-  return tag
+  return Promise.all(releases)
 }
 
-function sliceCommits (commits, { commitLimit, backfillLimit }, emptyRelease) {
+function getCommitLimit ({ commitLimit, backfillLimit }, emptyRelease, breakingCount) {
   if (commitLimit === false) {
-    return commits
+    return undefined // Return all commits
   }
   const limit = emptyRelease ? backfillLimit : commitLimit
-  const minLimit = commits.filter(c => c.breaking).length
-  return commits.slice(0, Math.max(minLimit, limit))
+  return Math.max(breakingCount, limit)
 }
 
 function filterCommit (commit, { ignoreCommitPattern }, merges) {
@@ -97,9 +62,8 @@ function filterCommit (commit, { ignoreCommitPattern }, merges) {
   if (commit.breaking) {
     return true
   }
-  if (ignoreCommitPattern) {
-    // Filter out commits that match ignoreCommitPattern
-    return new RegExp(ignoreCommitPattern).test(commit.subject) === false
+  if (ignoreCommitPattern && new RegExp(ignoreCommitPattern).test(commit.subject)) {
+    return false
   }
   if (semver.valid(commit.subject)) {
     // Filter out version commits
@@ -135,3 +99,12 @@ function commitSorter ({ sortCommits }) {
     return (b.insertions + b.deletions) - (a.insertions + a.deletions)
   }
 }
+
+function getCompareLink (previousTag, tag, remote, { tagPrefix = '' }) {
+  if (!previousTag) {
+    return null
+  }
+  const from = `${tagPrefix}${previousTag}`
+  const to = tag ? `${tagPrefix}${tag}` : 'HEAD'
+  return remote.getCompareLink(from, to)
+}

src/remote.js

@@ -6,10 +6,10 @@ export async function fetchRemote (options) {
   return getRemote(remoteURL, options)
 }
 
-function getRemote (remoteURL, options = {}) {
+export function getRemote (remoteURL, options = {}) {
   const overrides = getOverrides(options)
   if (!remoteURL) {
-    // No point warning if everything is overriddens
+    // No point warning if everything is overridden
     if (Object.keys(overrides).length !== 4) {
       console.warn(`Warning: Git remote ${options.remote} was not found`)
     }