Release

.releaserc.js

@@ -10,7 +10,7 @@ module.exports = {
       {
         releaseRules: {
           patch: {
-            include: [':bento:', ':arrow_up:'],
+            include: [':bento:', ':arrow_up:', ':lock:'],
           },
         },
         releaseNotes: {

README.md

@@ -146,6 +146,8 @@ interface EmojiArrayModifier {
 
 All templates file are compiled and renderered by [`handlebars`](http://handlebarsjs.com/), therefore you may need to get familiar with the `.hbs` format before starting to customize your own templates.
 
+`semver` is a boolean to define if releaseNotes should be based on Gitmoji only or on key semver associated to gitmoji used in commit to determine the next release tag.
+
 `partials` is a map from the partial name to the content of the partial template.
 
 `helpers` is a map from the helper name to the helper function. There is already a default helper `datetime` which takes a format string as the first argument and return a formatted current timestamp. See [npm/dateformat](https://www.npmjs.com/package/dateformat) for more information about how to format a timestamp and see [the default template](https://github.com/momocow/semantic-release-gitmoji/blob/master/lib/assets/templates/default-template.hbs#L2) as an example.
@@ -164,6 +166,7 @@ There are five variables that can be used in `issueResolution.template`:
 ```ts
 interface ReleaseNotesOptions {
   template?: TemplateContent
+  semver?: Boolean
   partials?: Record<string, TemplateContent>
   helpers?: Record<string, Function>
   issueResolution?: {

lib/assets/default-config.js

@@ -24,6 +24,7 @@ module.exports = {
     prerelease: []
   },
   releaseNotes: {
+    semver: false,
     template: readFileAsync(path.join(TEMPLATE_DIR, 'default-template.hbs')),
     partials: {
       commitTemplate: readFileAsync(path.join(TEMPLATE_DIR, 'commit-template.hbs'))

lib/assets/templates/default-template-semver.hbs

@@ -0,0 +1,28 @@
+{{#if compareUrl}}
+# [v{{nextRelease.version}}]({{compareUrl}}) ({{datetime "UTC:yyyy-mm-dd"}})
+{{else}}
+# v{{nextRelease.version}} ({{datetime "UTC:yyyy-mm-dd"}})
+{{/if}}
+
+{{#with commits}}
+{{#if major}}
+## 💥 Breaking Changes
+{{#each major}}
+- {{> commitTemplate}}
+{{/each}}
+{{/if}}
+
+{{#if minor}}
+## ✨ New Features
+{{#each minor}}
+- {{> commitTemplate}}
+{{/each}}
+{{/if}}
+
+{{#if patch}}
+## 🐛 Fixes
+{{#each patch}}
+- {{> commitTemplate}}
+{{/each}}
+{{/if}}
+{{/with}}

lib/helper/get-config.js

@@ -3,7 +3,13 @@ const _mergeWith = require('lodash.mergewith')
 const _cloneDeep = require('lodash.clonedeep')
 const _uniq = require('lodash.uniq')
 
+const path = require('path')
+const fs = require('fs')
+const { promisify } = require('util')
+const readFileAsync = promisify(fs.readFile)
+
 const DEFAULT_CONFIG = require('../assets/default-config')
+const TEMPLATE_DIR = path.join(__dirname, '../assets/templates')
 
 function normalizeEmojis (arr = []) {
   return (Array.isArray(arr) ? arr : [arr])
@@ -25,5 +31,8 @@ function handleArrayConfig (dest, src) {
 }
 
 module.exports = function getConfig (userConfig) {
+  if (userConfig && 'releaseNotes' in userConfig && 'semver' in userConfig.releaseNotes && userConfig.releaseNotes.semver) {
+    DEFAULT_CONFIG.releaseNotes.template = readFileAsync(path.join(TEMPLATE_DIR, 'default-template-semver.hbs'))
+  }
   return _mergeWith(_cloneDeep(DEFAULT_CONFIG), userConfig, handleArrayConfig)
 }

lib/helper/parse-commits.js

@@ -1,6 +1,7 @@
 const issueRegex = require('issue-regex')
 const emojiRegex = require('emoji-regex/text')
 const { emojify } = require('node-emoji')
+const { gitmojis } = require('gitmojis')
 
 const resolveIssueRef = require('./resolve-issue-ref')
 
@@ -34,9 +35,10 @@ function parseGitmoji ({ subject = '', message = '', body = '' } = {}, issues =
   if (!matched || matched.index !== 0) return null
 
   const gitmoji = matched[0]
+  const semver = gitmojis.find(item => item.emoji === gitmoji).semver || 'other'
   subject = subject.replace(new RegExp('^' + gitmoji), '')
 
-  return { subject, message: subject + '\n\n' + body, gitmoji }
+  return { subject, message: subject + '\n\n' + body, gitmoji, semver }
 }
 
 module.exports = function parseCommits (commits = [], mixins = {}, options = {}) {
@@ -53,9 +55,9 @@ module.exports = function parseCommits (commits = [], mixins = {}, options = {})
       }
     })
     .reduce((acc, commit) => {
-      if (commit.gitmoji) {
-        if (!Array.isArray(acc[commit.gitmoji])) acc[commit.gitmoji] = []
-        acc[commit.gitmoji].push(commit)
+      if (options.semver) {
+        if (!Array.isArray(acc[commit.semver])) acc[commit.semver] = []
+        acc[commit.semver].push(commit)
 
         if (commit.task) {
           // commits are in the descending order
@@ -67,7 +69,24 @@ module.exports = function parseCommits (commits = [], mixins = {}, options = {})
             taskMap.get(commit.task).wip.push(commit)
           }
         }
+        return acc
+      } else {
+        if (commit.gitmoji) {
+          if (!Array.isArray(acc[commit.gitmoji])) acc[commit.gitmoji] = []
+          acc[commit.gitmoji].push(commit)
+
+          if (commit.task) {
+            // commits are in the descending order
+            if (!taskMap.has(commit.task) && commit.gitmoji !== '🚧') {
+              // it is the final commit if it has not been in the task map
+              taskMap.set(commit.task, commit)
+            } else if (taskMap.has(commit.task) && commit.gitmoji === '🚧') {
+              // the final commit exists so this commit is the releted wip commits
+              taskMap.get(commit.task).wip.push(commit)
+            }
+          }
+        }
+        return acc
       }
-      return acc
     }, {})
 }

lib/release-notes.js

@@ -28,14 +28,15 @@ module.exports = class ReleaseNotes {
   /**
    * @param {object} context
    */
-  constructor (context, { issueResolution, template, partials, helpers } = {}) {
+  constructor (context, { issueResolution, template, partials, helpers, semver } = {}) {
     debug('Found %d commits', context.commits.length)
 
     const { owner, name: repo, source } = parseGitUrl(context.options.repositoryUrl)
 
     debug('Git remote: %s', source)
     debug('Repository: %s/%s', owner, repo)
 
+    this._semver = semver
     this._template = template
     this._partials = partials
     this._helpers = {
@@ -50,7 +51,8 @@ module.exports = class ReleaseNotes {
       repo,
       source,
       commits: parseCommits(context.commits, { owner, repo, source }, {
-        issues: { owner, repo, source, ...issueResolution }
+        issues: { owner, repo, source, ...issueResolution },
+        semver: this._semver
       })
     }
 
@@ -67,20 +69,34 @@ module.exports = class ReleaseNotes {
     // cache hits
     if (this._rtype) return this._rtype
 
-    for (const RTYPE of RELEASE_TYPES) {
-      debug('Testing against release type "%s"', RTYPE)
-      for (let gitmoji of releaseSchema[RTYPE]) {
-        gitmoji = emojify(gitmoji)
-        debug('Testing against gitmoji "%s "', gitmoji)
+    if (this._semver) {
+      for (const RTYPE of RELEASE_TYPES) {
+        debug('Testing against release type "%s"', RTYPE)
         if (
-          this._context.commits[gitmoji] &&
-          this._context.commits[gitmoji].length > 0
+          this._context.commits[RTYPE] &&
+          this._context.commits[RTYPE].length > 0
         ) {
           debug('Release type is now "%s".', RTYPE)
           this._rtype = RTYPE
           return RTYPE
         }
       }
+    } else {
+      for (const RTYPE of RELEASE_TYPES) {
+        debug('Testing against release type "%s"', RTYPE)
+        for (let gitmoji of releaseSchema[RTYPE]) {
+          gitmoji = emojify(gitmoji)
+          debug('Testing against gitmoji "%s "', gitmoji)
+          if (
+            this._context.commits[gitmoji] &&
+            this._context.commits[gitmoji].length > 0
+          ) {
+            debug('Release type is now "%s".', RTYPE)
+            this._rtype = RTYPE
+            return RTYPE
+          }
+        }
+      }
     }
   }
 
@@ -123,18 +139,27 @@ module.exports = class ReleaseNotes {
     if (this._template instanceof Promise) {
       this._template = await this._template
     }
-
     this._renderer = hbs.compile(this._template.toString())
   }
 
   toString () {
-    return this._renderer({
-      ...this._context,
-      commits: proxifyCommitsMap(this._context.commits)
-    }, {
-      allowProtoPropertiesByDefault: true
-    })
-      .replace(/\n{3,}/g, '\n\n') // allow a blank line
+    if (this._semver) {
+      return this._renderer({
+        ...this._context,
+        commits: this._context.commits
+      }, {
+        allowProtoPropertiesByDefault: true
+      })
+        .replace(/\n{3,}/g, '\n\n') // allow a blank line
+    } else {
+      return this._renderer({
+        ...this._context,
+        commits: proxifyCommitsMap(this._context.commits)
+      }, {
+        allowProtoPropertiesByDefault: true
+      })
+        .replace(/\n{3,}/g, '\n\n') // allow a blank line
+    }
   }
 
   /**