test: add a test for parsing commit messages with code

googleapis · Apr 16, 2024 · b3fd9b7 · b3fd9b7
1 parent 08331fa
commit b3fd9b7
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 0 deletions.
diff --git a/test/commits.ts b/test/commits.ts
@@ -82,6 +82,18 @@ describe('parseConventionalCommits', () => {
     expect(conventionalCommits[0].references[0].action).to.eql('Fixes');
   });
 
+  it('parse commits with code examples', async () => {
+    const commits = [buildCommitFromFixture('bug-with-code')];
+    const conventionalCommits = parseConventionalCommits(commits);
+    expect(conventionalCommits).lengthOf(1);
+    expect(conventionalCommits[0].type).to.eql('fix');
+    expect(conventionalCommits[0].breaking).to.be.false;
+    expect(conventionalCommits[0].references).lengthOf(1);
+    expect(conventionalCommits[0].references[0].prefix).to.eql('#');
+    expect(conventionalCommits[0].references[0].issue).to.eql('123');
+    expect(conventionalCommits[0].references[0].action).to.eql('Fixes');
+  });
+
   it('captures git trailers', async () => {
     const commits = [buildCommitFromFixture('git-trailers-with-breaking')];
     const conventionalCommits = parseConventionalCommits(commits);

diff --git a/test/fixtures/commit-messages/bug-with-code.txt b/test/fixtures/commit-messages/bug-with-code.txt
@@ -0,0 +1,9 @@
+fix: some fix
+
+Example:
+
+```
+page.on('request', (request) => {})
+```
+
+Fixes #123