feat: add PR link support to changelog schema

Signed-off-by: Rohit Agrawal <[email protected]>

Author: agrawroh

envoy.base.utils/envoy/base/utils/abstract/project/changelog.py

@@ -1,4 +1,3 @@
-
 import logging
 import pathlib
 import re
@@ -95,9 +94,18 @@ def lines(self) -> list[str]:
 
     def _parse_line(self, line: str) -> typing.ChangeDict:
         area, change = line[2:].split(":", 1)
-        return dict(
-            area=area,
-            change=typing.Change(change.lstrip(" ")))
+
+        # Try to extract PR reference from the change text if it exists
+        pr_match = re.search(r"(?:PR |#)(\d+)", change)
+        pr = pr_match.group(1) if pr_match else None
+
+        result: typing.ChangeDict = {
+            "area": area,
+            "change": typing.Change(change.lstrip(" "))
+        }
+        if pr:
+            result["pr"] = pr
+        return result
 
 
 @abstracts.implementer(interface.IChangelogEntry)
@@ -125,6 +133,10 @@ def area(self) -> str:
     def change(self) -> str:
         return self.entry["change"]
 
+    @property
+    def pr(self) -> str | None:
+        return self.entry.get("pr")
+
 
 @abstracts.implementer(interface.IChangelog)
 class AChangelog(metaclass=abstracts.Abstraction):
@@ -141,7 +153,8 @@ def get_data(cls, path) -> typing.ChangelogDict:
             {k: (v
                  if k == "date"
                  else [dict(area=c["area"],
-                            change=typing.Change(c["change"]))
+                            change=typing.Change(c["change"]),
+                            **({"pr": c["pr"]} if "pr" in c else {}))
                        for c
                        in v])
              for k, v

envoy.base.utils/envoy/base/utils/interface.py

@@ -1,4 +1,3 @@
-
 from __future__ import annotations
 
 import pathlib
@@ -128,6 +127,12 @@ def change(self) -> str:
         """Description of the change for this entry."""
         raise NotImplementedError
 
+    @property
+    @abstracts.interfacemethod
+    def pr(self) -> str | None:
+        """PR reference number for this entry."""
+        raise NotImplementedError
+
 
 class IChangelog(metaclass=abstracts.Interface):
     """A changelog."""

envoy.base.utils/envoy/base/utils/typing.py

@@ -1,6 +1,5 @@
-
 import pathlib
-from typing import TypedDict
+from typing import TypedDict, NotRequired
 
 from packaging import version as _version
 
@@ -16,11 +15,13 @@ def __add__(self, other: str) -> "Change":
 class SourceChangeDict(TypedDict):
     area: str
     change: str
+    pr: NotRequired[str]  # Optional PR reference
 
 
 class ChangeDict(TypedDict):
     area: str
     change: Change
+    pr: NotRequired[str]  # Optional PR reference
 
 
 ChangeList = list[ChangeDict]

envoy.base.utils/tests/test_abstract_project_changelogs.py

@@ -1,4 +1,3 @@
-
 import json
 import pathlib
 import types
@@ -1340,18 +1339,25 @@ def test_legacy_changelog_lines():
 def test_legacy_changelog__parse_line(patches):
     legacy = abstract.project.changelog.LegacyChangelog("CONTENT")
     patched = patches(
+        "re",
         "dict",
         "typing",
         prefix="envoy.base.utils.abstract.project.changelog")
     line = MagicMock()
     area = MagicMock()
     change = MagicMock()
     line.__getitem__.return_value.split.return_value = [area, change]
+    pr_match = MagicMock()
+    pr_match.group.return_value = "12345"
 
-    with patched as (m_dict, m_typing):
-        assert (
-            legacy._parse_line(line)
-            == m_dict.return_value)
+    with patched as (m_re, m_dict, m_typing):
+        m_re.search.return_value = pr_match
+        m_typing.Change.return_value = typing.Change("Test Change")
+        assert legacy._parse_line(line) == {
+            "area": area,
+            "change": m_typing.Change.return_value,
+            "pr": "12345"
+        }
 
     assert (
         line.__getitem__.call_args
@@ -1360,8 +1366,11 @@ def test_legacy_changelog__parse_line(patches):
         line.__getitem__.return_value.split.call_args
         == [(":", 1), {}])
     assert (
-        m_dict.call_args
-        == [(), dict(area=area, change=m_typing.Change.return_value)])
+        m_re.search.call_args
+        == [(r"(?:PR |#)(\d+)", change), {}])
+    assert (
+        pr_match.group.call_args
+        == [(1,), {}])
     assert (
         m_typing.Change.call_args
         == [(change.lstrip.return_value, ), {}])

envoy.base.utils/tests/test_utils.py

@@ -206,7 +206,8 @@ def test_cd_and_return(path):
 
     with utils.cd_and_return(path):
         assert pathlib.Path.cwd() != cwd
-        assert pathlib.Path.cwd() == pathlib.Path("/tmp")
+        # On macOS, /tmp is a symlink to /private/tmp
+        assert pathlib.Path.cwd().resolve() == pathlib.Path("/tmp").resolve()
 
     assert pathlib.Path.cwd() == cwd