fix: Add commit hash when generating breaking changes

Fixes #120
python-semantic-release · Aug 5, 2019 · 0c74faf · 0c74faf
1 parent 2c5dd80
commit 0c74faf
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 2 deletions.
diff --git a/semantic_release/history/logs.py b/semantic_release/history/logs.py
@@ -102,12 +102,12 @@ def generate_changelog(from_version: str, to_version: str = None) -> dict:
             if message[3][1] and 'BREAKING CHANGE' in message[3][1]:
                 parts = re_breaking.match(message[3][1])
                 if parts:
-                    changes['breaking'].append(parts.group(1))
+                    changes['breaking'].append((_hash, parts.group(1)))
 
             if message[3][2] and 'BREAKING CHANGE' in message[3][2]:
                 parts = re_breaking.match(message[3][2])
                 if parts:
-                    changes['breaking'].append(parts.group(1))
+                    changes['breaking'].append((_hash, parts.group(1)))
 
         except UnknownCommitMessageStyleError as err:
             debug('Ignoring', err)

diff --git a/tests/test_history.py b/tests/test_history.py
@@ -111,6 +111,14 @@ def test_should_generate_all_sections(self):
             self.assertGreater(len(changelog['fix']), 0)
             self.assertGreater(len(changelog['breaking']), 0)
 
+    def test_should_include_hash_in_section_contents(self):
+        with mock.patch('semantic_release.history.logs.get_commit_log',
+                        lambda *a, **k: ALL_KINDS_OF_COMMIT_MESSAGES):
+            changelog = generate_changelog('0.0.0')
+            self.assertEqual(changelog['breaking'][0][0], MAJOR[0])
+            self.assertEqual(changelog['feature'][0][0], MINOR[0])
+            self.assertEqual(changelog['fix'][0][0], PATCH[0])
+
     def test_should_only_read_until_given_version(self):
         with mock.patch('semantic_release.history.logs.get_commit_log',
                         lambda *a, **k: MAJOR_LAST_RELEASE_MINOR_AFTER):