feat(changelog): add changelog_table component (python-semantic-release#242)

danth · web-flow · commit fe6a7e7fa014 · 2020-05-24T09:24:43.000+01:00
Add an alternative changelog component which displays each section as a row in a table. Fixes python-semantic-release#237
diff --git a/docs/configuration.rst b/docs/configuration.rst
@@ -204,6 +204,11 @@ The following components are included in Python Semantic Release:
   List of commits between this version and the previous one, with sections and
   headings for each type of change present in the release.
 
+- :py:func:`semantic_release.changelog.changelog_table`
+
+  List of commits between this version and the previous one, dsplayed in a
+  table.
+
 - :py:func:`semantic_release.changelog.compare_url`
 
   Link to view a comparison between this release and the previous one on
diff --git a/semantic_release/changelog/__init__.py b/semantic_release/changelog/__init__.py
@@ -3,7 +3,7 @@
 from ..helpers import LoggedFunction
 from ..settings import config, current_changelog_components
 
-from .changelog import changelog_headers  # noqa isort:skip
+from .changelog import changelog_headers, changelog_table  # noqa isort:skip
 from .compare import compare_url  # noqa isort:skip
 
 logger = logging.getLogger(__name__)
diff --git a/semantic_release/changelog/changelog.py b/semantic_release/changelog/changelog.py
@@ -28,3 +28,17 @@ def changelog_headers(
             output += "* {0} ({1})\n".format(item[1], item[0])
 
     return output
+
+
+def changelog_table(
+    changelog: dict, changelog_sections: list, **kwargs
+) -> str:
+    output = "| Type | Change |\n| --- | --- |\n"
+
+    for section in get_changelog_sections(changelog, changelog_sections):
+        items = "<br>".join([
+            f"{item[0]} ({item[1]})" for item in changelog[section]
+        ])
+        output += f"| {section.title()} | {items} |\n"
+
+    return output
diff --git a/tests/test_changelog.py b/tests/test_changelog.py
@@ -1,7 +1,7 @@
 import mock
 
 from semantic_release.changelog import markdown_changelog
-from semantic_release.changelog.changelog import get_changelog_sections
+from semantic_release.changelog.changelog import get_changelog_sections, changelog_table
 from semantic_release.changelog.compare import compare_url, get_github_compare_url
 
 
@@ -38,6 +38,18 @@ def test_markdown_changelog():
     )
 
 
+def test_changelog_table():
+    assert changelog_table({
+        "feature": [("commit1", "sha1"), ("commit2", "sha2")],
+        "fix": [("commit3", "sha3")]
+    }, ["section1", "section2"]) == (
+        "| Type | Change |\n"
+        "| --- | --- |\n"
+        "| Feature | commit1 (sha1)<br>commit2 (sha2) |\n"
+        "| Fix | commit3 (sha3) |\n"
+    )
+
+
 def test_should_not_output_heading():
     assert "v1.0.1" not in markdown_changelog("1.0.1", {},)
 
