#149 - Merge labels from PR and the connected issue (#159)

* #149 - Merge labels from PR and the connected issue
- Labels are now holded on record itself as set of strings.

Author: miroslavpojer

DEVELOPER.md

@@ -31,8 +31,9 @@ Pylint displays a global evaluation score for the code, rated out of a maximum s
 
 ### Set Up Python Environment
 ```shell
-python3 -m venv venv
-source venv/bin/activate
+python3 -m venv .venv
+source .venv/bin/activate
+pip install --upgrade pip
 pip install -r requirements.txt
 ```
 

main.py

@@ -31,7 +31,6 @@
 from release_notes_generator.action_inputs import ActionInputs
 from release_notes_generator.utils.gh_action import set_action_output
 from release_notes_generator.utils.logging_config import setup_logging
-from release_notes_generator.filter import FilterByRelease
 
 warnings.filterwarnings("ignore", category=InsecureRequestWarning)
 

release_notes_generator/model/commit_record.py

@@ -35,10 +35,6 @@ def is_closed(self) -> bool:
     def is_open(self) -> bool:
         return False
 
-    @property
-    def labels(self):
-        return []
-
     @property
     def authors(self) -> list[str]:
         return [self._commit.author.login] if self._commit.author else []

release_notes_generator/model/issue_record.py

@@ -27,6 +27,8 @@ def __init__(self, issue: Issue, skip: bool = False):
         super().__init__(skip=skip)
 
         self._issue: Issue = issue
+        self._labels = {label.name for label in self._issue.get_labels()}
+
         self._pull_requests: dict[int, PullRequest] = {}
         self._commits: dict[int, dict[str, Commit]] = {}
 
@@ -44,10 +46,6 @@ def is_closed(self) -> bool:
     def is_open(self) -> bool:
         return self._issue.state == self.ISSUE_STATE_OPEN
 
-    @property
-    def labels(self):
-        return [label.name for label in self._issue.labels]
-
     @property
     def authors(self) -> list[str]:
         if not self._issue or not self._issue.user:
@@ -161,6 +159,7 @@ def register_pull_request(self, pull: PullRequest) -> None:
         Returns: None
         """
         self._pull_requests[pull.number] = pull
+        self._labels.update({label.name for label in pull.get_labels()})
 
     def register_commit(self, pull: PullRequest, commit: Commit) -> None:
         """

release_notes_generator/model/pull_request_record.py

@@ -25,6 +25,8 @@ def __init__(self, pull: PullRequest, skip: bool = False):
         super().__init__(skip=skip)
 
         self._pull_request: PullRequest = pull
+        self._labels = {label.name for label in self._pull_request.get_labels()}
+
         self._commits: dict[str, Commit] = {}
 
     # properties - override Record properties
@@ -45,10 +47,6 @@ def is_closed(self) -> bool:
     def is_open(self) -> bool:
         return self._pull_request.state == self.PR_STATE_OPEN
 
-    @property
-    def labels(self):
-        return [label.name for label in self._pull_request.labels]
-
     @property
     def authors(self) -> list[str]:
         if not self._pull_request or not self._pull_request.user:
@@ -242,7 +240,8 @@ def _get_rls_notes_code_rabbit(
         Parameters:
             pull (PullRequest): The pull request from which to extract release notes.
             line_marks (list[str]): A list of characters that indicate the start of a release notes section.
-            cr_detection_regex (re.Pattern[str]): A regex pattern to detect the start of the Code Rabbit release notes section.
+            cr_detection_regex (re.Pattern[str]): A regex pattern to detect the start of the Code Rabbit release notes
+             section.
         Returns:
             str: The extracted release notes as a string. If no release notes are found, returns an empty string.
         """

release_notes_generator/model/record.py

@@ -38,6 +38,7 @@ def __init__(self, skip: bool = False):
         self._present_in_chapters = 0
         self._skip = skip
         self._is_release_note_detected: Optional[bool] = None
+        self._labels: set[str] = set()
         self._rls_notes: Optional[str] = None  # single annotation here
 
     # properties
@@ -55,6 +56,15 @@ def skip(self) -> bool:
         """Check if the record should be skipped during output generation process."""
         return self._skip
 
+    @property
+    def labels(self) -> list[str]:
+        """
+        Gets the labels of the record.
+        Returns:
+            list[str]: A list of labels associated with the record.
+        """
+        return list(self._labels)
+
     @property
     @abstractmethod
     def record_id(self) -> int | str:
@@ -82,15 +92,6 @@ def is_open(self) -> bool:
             bool: True if the record is open, False otherwise.
         """
 
-    @property
-    @abstractmethod
-    def labels(self) -> list[str]:
-        """
-        Gets the labels of the record.
-        Returns:
-            list[str]: A list of labels associated with the record.
-        """
-
     @property
     @abstractmethod
     def authors(self) -> list[str]:

release_notes_generator/record/record_factory.py

@@ -58,9 +58,9 @@ def generate(github: Github, data: MinedData) -> dict[int | str, Record]:
 
         def register_pull_request(pull: PullRequest, skip_rec: bool) -> None:
             detected_issues = extract_issue_numbers_from_body(pull)
-            logger.debug(f"Detected issues - from body: {detected_issues}")
+            logger.debug("Detected issues - from body: %s", detected_issues)
             detected_issues.update(safe_call(get_issues_for_pr)(pull_number=pull.number))
-            logger.debug(f"Detected issues - final: {detected_issues}")
+            logger.debug("Detected issues - final: %s", detected_issues)
 
             for parent_issue_number in detected_issues:
                 # create an issue record if not present for PR parent
@@ -98,14 +98,14 @@ def register_pull_request(pull: PullRequest, skip_rec: bool) -> None:
 
         logger.debug("Registering pull requests to records...")
         for pull in data.pull_requests:
-            pull_labels = [label.name for label in pull.labels]
+            pull_labels = [label.name for label in pull.get_labels()]
             skip_record: bool = any(item in pull_labels for item in ActionInputs.get_skip_release_notes_labels())
 
             if not safe_call(get_issues_for_pr)(pull_number=pull.number) and not extract_issue_numbers_from_body(pull):
                 records[pull.number] = PullRequestRecord(pull, skip=skip_record)
                 logger.debug("Created record for PR %d: %s", pull.number, pull.title)
             else:
-                logger.debug(f"Registering pull number: {pull.number}, title : {pull.title}")
+                logger.debug("Registering pull number: %s, title : %s", pull.number, pull.title)
                 register_pull_request(pull, skip_record)
 
         logger.debug("Registering commits to records...")
@@ -158,7 +158,7 @@ def _create_record_for_issue(records: dict[int | str, Record], i: Issue) -> None
         @return: None
         """
         # check for skip labels presence and skip when detected
-        issue_labels = [label.name for label in i.labels]
+        issue_labels = [label.name for label in i.get_labels()]
         skip_record = any(item in issue_labels for item in ActionInputs.get_skip_release_notes_labels())
         records[i.number] = IssueRecord(issue=i, skip=skip_record)
 

requirements.txt

@@ -1,13 +1,13 @@
-pytest==7.4.3
-pytest-cov==5.0.0
-pytest-mock==3.14.0
+pytest==8.4.2
+pytest-cov==6.3.0
+pytest-mock==3.15.0
 PyGithub==1.59.0
-pylint==3.2.6
-requests==2.31.0
-black==24.8.0
+pylint==3.3.8
+requests==2.32.5
+black==25.1.0
 PyYAML==6.0.2
-semver==3.0.2
-mypy==1.15.0
-mypy-extensions==1.0.0
-types-requests==2.32.0.20250328
-types-PyYAML==6.0.2
+semver==3.0.4
+mypy==1.17.1
+mypy-extensions==1.1.0
+types-requests==2.32.4.20250809
+types-PyYAML==6.0.12.20250822