chore: generate release notes with the new commit format (#2063)

* chore: generate notes with new commit format

* capitalize message and put scope in bold

* update PR templates

Author: mcasimir

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,7 +1,14 @@
-<!-- Ticket number and a general summary of your changes in the Title above -->
-<!-- e.g. COMPASS-1111: updates ace editor width in agg pipeline view -->
+<!--
+  ^^^^^
+  Please fill the title above according to https://www.conventionalcommits.org/en/v1.0.0/.
 
-<!--- The following fields are not obligatory. Use your best judgement on what you think is applicable to the work you've done -->
+  type(scope): message <TICKET-NUMBER>
+
+  eg. fix(crud): updates ace editor width in agg pipeline view COMPASS-1111
+
+  NOTE: use `feat`, `fix` and `perf` for user facing changes that will be part of
+  release notes.
+-->
 
 ## Description
 <!--- Describe your changes in detail -->

release/changelog.js

@@ -0,0 +1,88 @@
+const { cli } = require('cli-ux');
+const chalk = require('chalk');
+const _ = require('lodash');
+const git = require('./git');
+const ux = require('./ux');
+
+function capitalize(s) {
+  if (typeof s !== 'string') return '';
+  return s.charAt(0).toUpperCase() + s.slice(1);
+}
+
+function renderCommit({ scope, message, pr, ticket }) {
+  let links = [ticket, pr].filter(Boolean).join(', ');
+
+  if (links) {
+    links = ` (${links})`;
+  }
+
+  return `${scope ? `**${scope}**` + ': ' : ''}${capitalize(message)}${links}`;
+}
+
+async function render(previousTag, releaseTag) {
+  cli.info('');
+  cli.info(`Changes from ${chalk.bold(previousTag)}:`);
+
+  const parseCommit = (commit) => {
+    const PR_RE = /\s+\((#\d+)\)$/;
+    const pr = (commit.match(PR_RE) || [])[1];
+    commit = commit.replace(PR_RE, '');
+
+    const TICKET_RE_WITH_BRACES = /\s+\((COMPASS-\d+)\)$/;
+    let ticket = (commit.match(TICKET_RE_WITH_BRACES) || [])[1];
+    commit = commit.replace(TICKET_RE_WITH_BRACES, '');
+
+    const TICKET_RE_WITHOUT_BRACES = /\s+(COMPASS-\d+)$/;
+    ticket = (commit.match(TICKET_RE_WITHOUT_BRACES) || [])[1];
+    commit = commit.replace(TICKET_RE_WITHOUT_BRACES, '');
+
+    const COMMIT_RE = /^(?<type>feat|fix|perf)(\((?<scope>[^)]*)\))?:\s*(?<message>\S.*)/;
+    const groups = (commit.match(COMMIT_RE) || []).groups;
+    if (!groups) {
+      return;
+    }
+
+    if (groups.scope && groups.scope.match(/COMPASS-\d+/)) {
+      ticket = groups.scope;
+      groups.scope = '';
+    }
+
+    groups.message = groups.message.trim();
+    return {...groups, pr, ticket};
+  };
+
+  const renderLine = (commit) => `- ${renderCommit(commit)}`;
+  const renderSection = ({ title, commits }) => `## ${title}\n\n${commits.map(renderLine).join('\n')}\n\n`;
+
+  const commits = _.uniq(await git.log(previousTag, releaseTag))
+    .map(parseCommit)
+    .filter(Boolean); // only conventional commits
+
+  const changes = [
+    {
+      title: 'Features',
+      commits: commits.filter(({ type }) => type === 'feat')
+    },
+    {
+      title: 'Bug Fixes',
+      commits: commits.filter(({ type }) => type === 'fix')
+    },
+    {
+      title: 'Performance Improvements',
+      commits: commits.filter(({ type }) => type === 'perf')
+    }
+  ]
+    .filter((section) => section.commits.length)
+    .map(renderSection)
+    .join('\n');
+
+  cli.info(
+    `${changes}You can see the full list of commits here:`,
+    '\n' + ux.link(`https://github.com/mongodb-js/compass/compare/${previousTag}...${releaseTag}`)
+  );
+}
+
+module.exports = {
+  render
+};
+

release/commands.js

@@ -1,5 +1,4 @@
 /* eslint-disable no-console */
-const _ = require('lodash');
 const { cli } = require('cli-ux');
 const chalk = require('chalk');
 const pkgUp = require('pkg-up');
@@ -17,6 +16,7 @@ const version = require('./version');
 const publishRelease = require('./publish');
 const waitForAssets = require('./wait-for-assets');
 const ux = require('./ux');
+const changelog = require('./changelog');
 
 async function getPackageJsonVersion() {
   return require(await pkgUp()).version;
@@ -166,18 +166,7 @@ async function releaseChangelog() {
     .reverse()
     .find((t) => semver.lt(t, releaseTag));
 
-  cli.info('');
-  cli.info(`Changes from ${chalk.bold(previousTag)}:`);
-  const changes = _.uniq(await git.log(previousTag, releaseTag))
-    .filter((line) => !semver.valid(line)) // filter out tag commits
-    .map((line) => `- ${line}`);
-
-  cli.info(changes.join('\n'));
-
-  cli.info('');
-  cli.info('You can see the full list of commits here:');
-  const githubCompareUrl = `https://github.com/mongodb-js/compass/compare/${previousTag}...${releaseTag}`;
-  cli.url(githubCompareUrl, githubCompareUrl);
+  await changelog.render(previousTag, releaseTag);
 }
 
 async function releasePublish() {

release/index.spec.js

@@ -278,57 +278,41 @@ describe('release', () => {
 
     describe('when the release tag exist', () => {
       beforeEach(async() => {
-        await commitAll('commit 1', 'v0.1.0');
-        await commitAll('commit 2', 'v0.2.0-beta.0');
-        await commitAll('commit 3');
-        await commitAll('commit 3'); // duplicate
+        await commitAll('fix: commit 1', 'v0.1.0');
+        await commitAll('fix: commit 2', 'v0.2.0-beta.0');
+        await commitAll('feat: commit 3');
+        await commitAll('feat: commit 3'); // duplicate
         await commitAll('v0.2.0-beta.0'); // version bump commit
         await commitAll('v0.2.0'); // version bump commit
         await checkoutBranch('1.0-releases');
-        await commitAll('commit 4', 'v1.0.0');
+        await commitAll('perf: commit 4', 'v1.0.0');
       });
 
       it('reports changes between 2 GAs', async() => {
         const { stdout } = await runReleaseCommand(['changelog']);
-        expect(stdout).to.contain(`Changes from v0.1.0:
-- commit 4
-- commit 3
-- commit 2
-
-You can see the full list of commits here:
-https://github.com/mongodb-js/compass/compare/v0.1.0...v1.0.0`);
+        expect(stdout).to.contain('\nChanges from v0.1.0:\n## Features\n\n- Commit 3\n\n\n## Bug Fixes\n\n- Commit 2\n\n\n## Performance Improvements\n\n- Commit 4\n\nYou can see the full list of commits here: \nhttps://github.com/mongodb-js/compass/compare/v0.1.0...v1.0.0');
       });
 
       it('reports changes between beta and GA', async() => {
         await npm.version('1.0.1-beta.0');
         await execa('git', ['add', '.']);
-        await commitAll('commit 5');
-        await commitAll('commit 6', 'v1.0.1-beta.0');
+        await commitAll('fix: commit 5');
+        await commitAll('fix: commit 6', 'v1.0.1-beta.0');
 
         const { stdout } = await runReleaseCommand(['changelog']);
-        expect(stdout).to.contain(`Changes from v1.0.0:
-- commit 6
-- commit 5
-
-You can see the full list of commits here:
-https://github.com/mongodb-js/compass/compare/v1.0.0...v1.0.1-beta.0`);
+        expect(stdout).to.contain('\nChanges from v1.0.0:\n## Bug Fixes\n\n- Commit 6\n- Commit 5\n\nYou can see the full list of commits here: \nhttps://github.com/mongodb-js/compass/compare/v1.0.0...v1.0.1-beta.0');
       });
 
       it('reports changes between beta and beta', async() => {
         await npm.version('1.0.1-beta.0');
-        await commitAll('commit 5');
-        await commitAll('commit 6', 'v1.0.1-beta.0');
+        await commitAll('feat: commit 5');
+        await commitAll('feat: commit 6', 'v1.0.1-beta.0');
         await npm.version('1.0.1-beta.1');
-        await commitAll('commit 7');
-        await commitAll('commit 8', 'v1.0.1-beta.1');
+        await commitAll('feat: commit 7');
+        await commitAll('feat: commit 8', 'v1.0.1-beta.1');
 
         const { stdout } = await runReleaseCommand(['changelog']);
-        expect(stdout).to.contain(`Changes from v1.0.1-beta.0:
-- commit 8
-- commit 7
-
-You can see the full list of commits here:
-https://github.com/mongodb-js/compass/compare/v1.0.1-beta.0...v1.0.1-beta.1`);
+        expect(stdout).to.contain('\nChanges from v1.0.1-beta.0:\n## Features\n\n- Commit 8\n- Commit 7\n\nYou can see the full list of commits here: \nhttps://github.com/mongodb-js/compass/compare/v1.0.1-beta.0...v1.0.1-beta.1');
       });
     });
   });