feat: add migration note parsing (#204)

Author: cjquines

__snapshots__/default-changelog-notes.ts.js

@@ -46,6 +46,7 @@ exports['DefaultChangelogNotes buildNotes should handle BREAKING CHANGE notes 1'
 ### ⚠ BREAKING CHANGES
 
 * some bugfix
+* **Migration:** migration note
 
 ### Bug Fixes
 

src/changelog-notes/default.ts

@@ -87,7 +87,10 @@ export class DefaultChangelogNotes implements ChangelogNotes {
       })
       .map(commit => {
         const notes = commit.notes
-          .filter(note => note.title === 'BREAKING CHANGE')
+          .filter(
+            note =>
+              note.title === 'BREAKING CHANGE' || note.title === 'Migration'
+          )
           .map(note =>
             replaceIssueLink(
               note,

src/commit.ts

@@ -116,9 +116,30 @@ function toConventionalChangelogFormat(
 
   // [<any body-text except pre-footer>]
   if (body) {
+    const migrationMessage: parser.Note = {
+      title: 'Migration',
+      text: '',
+    };
+    let hasMigration = false;
     visit(body, ['text', 'newline'], (node: parser.Text) => {
       headerCommit.body += node.value;
+      if (node.value.includes('# Migration')) {
+        hasMigration = true;
+      }
+      if (hasMigration) {
+        migrationMessage.text += node.value;
+      }
     });
+    if (migrationMessage.text !== '') {
+      // remove leading # Migration\n
+      migrationMessage.text = migrationMessage.text
+        .split('\n')
+        .slice(1)
+        .join('\n')
+        .trim();
+      migrationMessage.text = '**Migration:** ' + migrationMessage.text;
+      headerCommit.notes.push(migrationMessage);
+    }
   }
 
   // Extract BREAKING CHANGE notes, regardless of whether they fall in
@@ -169,7 +190,7 @@ function toConventionalChangelogFormat(
       }
     }
   );
-  if (breaking.text !== '') headerCommit.notes.push(breaking);
+  if (breaking.text !== '') headerCommit.notes.unshift(breaking);
 
   // Populates references array from footers:
   // references: [{

test/changelog-notes/default-changelog-notes.ts

@@ -98,7 +98,10 @@ describe('DefaultChangelogNotes', () => {
           type: 'fix',
           scope: null,
           bareMessage: 'some bugfix',
-          notes: [{title: 'BREAKING CHANGE', text: 'some bugfix'}],
+          notes: [
+            {title: 'BREAKING CHANGE', text: 'some bugfix'},
+            {title: 'Migration', text: '**Migration:** migration note'},
+          ],
           references: [],
           breaking: true,
         },

test/commits.ts

@@ -262,6 +262,15 @@ describe('parseConventionalCommits', () => {
   //   expect(conventionalCommits[0].type).to.equal('docs');
   //   expect(conventionalCommits[0].scope).is.null;
   // });
+
+  it('handles migration messages', async () => {
+    const commits = [buildCommitFromFixture('migration-message')];
+    const conventionalCommits = parseConventionalCommits(commits);
+    expect(conventionalCommits[0].notes[1].title).to.eql('Migration');
+    expect(conventionalCommits[0].notes[1].text).to.eql(
+      '**Migration:** my message'
+    );
+  });
 });
 
 function assertHasCommit(

test/fixtures/commit-messages/migration-message.txt

@@ -0,0 +1,8 @@
+refactor(sdk)!: change how path parameters are passed to resource methods
+
+We’ve changed the shape of how API path parameters (\`/api/pipes/{pipeId}\`)
+are passed to SDK methods (\`client.pipes.get(…)\`).
+
+# Migration
+
+my message