Improvements to the changelog. 1) Adding the integration domain and 2) Introduce the issue_origin support. By default this will be github for new entries, but for compat reasons, when we generate the markdown for entries, if the issue_origin isn't present then we'll default to gitlab. (baserow#4255)

Author: picklepete

changelog/src/changelog.py

@@ -43,7 +43,11 @@ def add(working_dir: Optional[str] = typer.Option(default=default_path)):
         issue_number = None
 
     ChangelogHandler(working_dir).add_entry(
-        domain_type, changelog_type, message, issue_number=issue_number
+        domain_type,
+        changelog_type,
+        message,
+        issue_number=issue_number,
+        issue_origin="github",  # All new changelogs originate from GitHub
     )
 
 

changelog/src/changelog_entry.py

@@ -4,6 +4,7 @@
 from typing import Dict, List, Optional, Union
 
 GITLAB_URL = os.environ.get("GITLAB_URL", "https://gitlab.com/baserow/baserow")
+GITHUB_URL = os.environ.get("GITHUB_URL", "https://github.com/baserow/baserow")
 
 
 class ChangelogEntry(abc.ABC):
@@ -17,6 +18,7 @@ def generate_entry_dict(
         self,
         domain_type_name: str,
         message: str,
+        issue_origin: str,
         issue_number: Optional[int] = None,
         bullet_points: List[str] = None,
     ) -> Dict[str, any]:
@@ -26,18 +28,24 @@ def generate_entry_dict(
         return {
             "type": self.type,
             "message": message,
-            "domain": domain_type_name,
+            "issue_origin": issue_origin,
             "issue_number": issue_number,
+            "domain": domain_type_name,
             "bullet_points": bullet_points,
             "created_at": datetime.now(tz=timezone.utc).strftime("%Y-%m-%d"),
         }
 
     @staticmethod
-    def get_markdown_string(message: str, issue_number: Union[int, None] = None) -> str:
+    def get_markdown_string(
+        message: str,
+        issue_number: Union[int, None] = None,
+        issue_origin: Optional[str] = "gitlab",
+    ) -> str:
         string = f"* {message}"
 
         if issue_number is not None:
-            string += f" [#{issue_number}]({GITLAB_URL}/-/issues/{issue_number})"
+            url_prefix = GITLAB_URL if issue_origin == "gitlab" else GITHUB_URL
+            string += f" [#{issue_number}]({url_prefix}/-/issues/{issue_number})"
 
         return string
 

changelog/src/domains.py

@@ -35,10 +35,16 @@ class AutomationDomain(BaserowDomain):
     heading = "Automation"
 
 
+class IntegrationDomain(BaserowDomain):
+    type = "integration"
+    heading = "Integration"
+
+
 domain_types: Dict[str, type[BaserowDomain]] = {
     CoreDomain.type: CoreDomain,
     DashboardDomain.type: DashboardDomain,
     DatabaseDomain.type: DatabaseDomain,
     BuilderDomain.type: BuilderDomain,
     AutomationDomain.type: AutomationDomain,
+    IntegrationDomain.type: IntegrationDomain,
 }

changelog/src/handler.py

@@ -40,6 +40,7 @@ def add_entry(
         changelog_entry_type_name: str,
         message: str,
         issue_number: Optional[int] = None,
+        issue_origin: Optional[str] = "github",
         release: str = UNRELEASED_FOLDER_NAME,
         bullet_points: List[str] = None,
     ) -> str:
@@ -57,7 +58,11 @@ def add_entry(
 
         with open(full_path, "w+") as entry_file:
             entry = changelog_entry_type().generate_entry_dict(
-                domain_type_name, message, issue_number, bullet_points=bullet_points
+                domain_type_name,
+                message,
+                issue_origin,
+                issue_number,
+                bullet_points=bullet_points,
             )
             json.dump(entry, entry_file, indent=4)
 
@@ -161,8 +166,13 @@ def generate_changelog_markdown_file(self):
                     )
                     entry_message = f"{domain_prefix}{entry['message']}"
 
+                    # Note: if no `issue_origin` is found, we default to "gitlab"
+                    # for compatibility with older entries. All new entries will
+                    # point to "github" as their origin.
                     entry_markdown_string = entry_type.get_markdown_string(
-                        entry_message, entry["issue_number"]
+                        entry_message,
+                        entry["issue_number"],
+                        entry.get("issue_origin", "gitlab"),
                     )
 
                     changelog_file.write(
@@ -193,7 +203,8 @@ def move_entries_to_release_folder(
             # Delete all .gitignore files in the subfolders of release folder because
             # there is not reason to have empty folders there.
             for gitignore_file in glob.glob(
-                f"{release_path}/**/.gitkeep", recursive=True):
+                f"{release_path}/**/.gitkeep", recursive=True
+            ):
                 os.remove(gitignore_file)
 
             # Delete all empty subfolders in the release folder because we don't need
@@ -213,7 +224,7 @@ def move_entries_to_release_folder(
         except FileExistsError:
             print(f'Release with name "{release_name}" already exists.')
         except OSError as e:
-            print(f'OS error occurred: {e}')
+            print(f"OS error occurred: {e}")
         return None
 
     @staticmethod

changelog/tests/changelog/test_changelog_handler.py

@@ -18,29 +18,29 @@ def test_add_entry(fs):
 
 def test_get_changelog_entries(fs):
     handler = ChangelogHandler()
-    handler.add_entry(DatabaseDomain.type, BugChangelogEntry.type, "1")
-    handler.add_entry(DatabaseDomain.type, BugChangelogEntry.type, "2")
+    handler.add_entry(DatabaseDomain.type, BugChangelogEntry.type, "msg1")
+    handler.add_entry(DatabaseDomain.type, BugChangelogEntry.type, "msg2")
 
     changelog_entries = handler.get_changelog_entries()
 
     assert BugChangelogEntry.type in changelog_entries
     assert [
-        BugChangelogEntry().generate_entry_dict(DatabaseDomain.type, "1"),
-        BugChangelogEntry().generate_entry_dict(DatabaseDomain.type, "2"),
+        BugChangelogEntry().generate_entry_dict(DatabaseDomain.type, "msg1", "github"),
+        BugChangelogEntry().generate_entry_dict(DatabaseDomain.type, "msg2", "github"),
     ] in changelog_entries.values()
 
 
 def test_get_changelog_entries_order(fs):
     handler = ChangelogHandler()
-    handler.add_entry(DatabaseDomain.type, BugChangelogEntry.type, "2")
-    handler.add_entry(DatabaseDomain.type, BugChangelogEntry.type, "1")
+    handler.add_entry(DatabaseDomain.type, BugChangelogEntry.type, "msg2")
+    handler.add_entry(DatabaseDomain.type, BugChangelogEntry.type, "msg1")
 
     changelog_entries = handler.get_changelog_entries()
 
     assert BugChangelogEntry.type in changelog_entries
     assert [
-        BugChangelogEntry().generate_entry_dict(DatabaseDomain.type, "1"),
-        BugChangelogEntry().generate_entry_dict(DatabaseDomain.type, "2"),
+        BugChangelogEntry().generate_entry_dict(DatabaseDomain.type, "msg1", "github"),
+        BugChangelogEntry().generate_entry_dict(DatabaseDomain.type, "msg2", "github"),
     ] in changelog_entries.values()