#171 - Introduce new records ID

.pylintrc

@@ -304,7 +304,7 @@ max-attributes=7
 max-bool-expr=5
 
 # Maximum number of branch for function / method body.
-max-branches=13
+max-branches=15
 
 # Maximum number of locals for function / method body.
 max-locals=20

release_notes_generator/builder/builder.py

@@ -38,7 +38,7 @@ class ReleaseNotesBuilder:
 
     def __init__(
         self,
-        records: dict[int | str, Record],
+        records: dict[str, Record],
         changelog_url: str,
         custom_chapters: CustomChapters,
     ):

release_notes_generator/chapters/base_chapters.py

@@ -104,9 +104,13 @@ def titles(self) -> list[str]:
         return [chapter.title for chapter in self.chapters.values()]
 
     @abstractmethod
-    def populate(self, records: dict[int | str, Record]) -> None:
+    def populate(self, records: dict[str, Record]) -> None:
         """
         Populates the chapters with records.
 
-        @param records: A dictionary of records where the key is an integer and the value is a Record object.
+        Parameters:
+            records (dict[str, Record]): A dictionary of records to populate the chapters with.
+
+        Returns:
+            None
         """

release_notes_generator/chapters/custom_chapters.py

@@ -39,12 +39,15 @@ class CustomChapters(BaseChapters):
     A class used to represent the custom chapters in the release notes.
     """
 
-    def populate(self, records: dict[int | str, Record]) -> None:
+    def populate(self, records: dict[str, Record]) -> None:
         """
         Populates the custom chapters with records.
 
-        @param records: A dictionary of records where the key is an integer and the value is a Record object.
-        @return: None
+        Parameters:
+            @param records: A dictionary of records keyed by 'owner/repo#number' and values are Record objects.
+
+        Returns:
+            None
         """
         for record_id, record in records.items():  # iterate all records
             # check if the record should be skipped
@@ -68,9 +71,19 @@ def populate(self, records: dict[int | str, Record]) -> None:
 
                 for record_label in records[record_id].labels:  # iterate all labels of the record (issue, or 1st PR)
                     if record_label in ch.labels and pulls_count > 0:
-                        if not records[record_id].is_present_in_chapters:
-                            ch.add_row(record_id, records[record_id].to_chapter_row(True))
-                            self.populated_record_numbers_list.append(record_id)
+                        if (
+                            not records[record_id].is_present_in_chapters
+                            and records[record_id].contains_change_increment()
+                        ):
+                            allow_dup = ActionInputs.get_duplicity_scope() in (
+                                DuplicityScopeEnum.CUSTOM,
+                                DuplicityScopeEnum.BOTH,
+                            )
+                            if (allow_dup or not records[record_id].is_present_in_chapters) and records[
+                                record_id
+                            ].contains_change_increment():
+                                ch.add_row(record_id, records[record_id].to_chapter_row(True))
+                                self.populated_record_numbers_list.append(record_id)
 
     def from_yaml_array(self, chapters: list[dict[str, str]]) -> "CustomChapters":
         """

release_notes_generator/chapters/service_chapters.py

@@ -93,7 +93,7 @@ def __init__(
 
         self.show_chapter_merged_prs_linked_to_open_issues = True
 
-    def populate(self, records: dict[int | str, Record]) -> None:
+    def populate(self, records: dict[str, Record]) -> None:
         """
         Populates the service chapters with records.
 

release_notes_generator/filter.py

@@ -61,8 +61,7 @@ def filter(self, data: MinedData) -> MinedData:
         Returns:
             MinedData: The filtered mined data.
         """
-        md = MinedData()
-        md.repository = data.repository
+        md = MinedData(data.repository)
         md.release = data.release
         md.since = data.since
 

release_notes_generator/generator.py

@@ -24,6 +24,7 @@
 from typing import Optional
 
 from github import Github
+from github.Repository import Repository
 
 from release_notes_generator.filter import FilterByRelease
 from release_notes_generator.miner import DataMiner
@@ -76,9 +77,14 @@ def generate(self) -> Optional[str]:
         @return: The generated release notes as a string, or None if the repository could not be found.
         """
         miner = DataMiner(self._github_instance, self._rate_limiter)
+        if not miner.check_repository_exists():
+            return None
+
         data = miner.mine_data()
+
         if data.is_empty():
             return None
+
         self.custom_chapters.since = data.since
 
         filterer = FilterByRelease()
@@ -92,26 +98,31 @@ def generate(self) -> Optional[str]:
 
         assert data_filtered_by_release.repository is not None, "Repository must not be None"
 
-        rls_notes_records: dict[int | str, Record] = self._get_record_factory(github=self._github_instance).generate(
-            data=data_filtered_by_release
-        )
+        rls_notes_records: dict[str, Record] = self._get_record_factory(
+            github=self._github_instance,
+            home_repository=data_filtered_by_release.repository,
+        ).generate(data=data_filtered_by_release)
 
         return ReleaseNotesBuilder(
             records=rls_notes_records,
             custom_chapters=self._custom_chapters,
             changelog_url=changelog_url,
         ).build()
 
-    def _get_record_factory(self, github: Github) -> DefaultRecordFactory:
+    def _get_record_factory(self, github: Github, home_repository: Repository) -> DefaultRecordFactory:
         """
         Determines and returns the appropriate RecordFactory instance based on the action inputs.
 
+        Parameters:
+            github (Github): An instance of the Github class.
+            home_repository (Repository): The home repository for which records are to be generated.
+
         Returns:
             DefaultRecordFactory: An instance of either IssueHierarchyRecordFactory or RecordFactory.
         """
         if ActionInputs.get_hierarchy():
             logger.info("Using IssueHierarchyRecordFactory based on action inputs.")
-            return IssueHierarchyRecordFactory(github)
+            return IssueHierarchyRecordFactory(github, home_repository)
 
         logger.info("Using default RecordFactory based on action inputs.")
-        return DefaultRecordFactory(github)
+        return DefaultRecordFactory(github, home_repository)

release_notes_generator/miner.py

@@ -47,18 +47,30 @@ def __init__(self, github_instance: Github, rate_limiter: GithubRateLimiter):
         self.github_instance = github_instance
         self._safe_call = safe_call_decorator(rate_limiter)
 
+    def check_repository_exists(self) -> bool:
+        """
+        Checks if the specified GitHub repository exists.
+
+        Returns:
+            bool: True if the repository exists, False otherwise.
+        """
+        repo: Repository = self._safe_call(self.github_instance.get_repo)(ActionInputs.get_github_repository())
+        if repo is None:
+            logger.error("Repository not found: %s", ActionInputs.get_github_repository())
+            return False
+        return True
+
     def mine_data(self) -> MinedData:
         """
         Mines data from GitHub, including repository information, issues, pull requests, commits, and releases.
         """
         logger.info("Starting data mining from GitHub...")
-        data = MinedData()
-
-        data.repository = self._safe_call(self.github_instance.get_repo)(ActionInputs.get_github_repository())
-        if data.repository is None:
+        repo: Repository = self._safe_call(self.github_instance.get_repo)(ActionInputs.get_github_repository())
+        if repo is None:
             logger.error("Repository not found: %s", ActionInputs.get_github_repository())
-            return data
+            raise ValueError("Repository not found")
 
+        data = MinedData(repo)
         data.release = self.get_latest_release(data.repository)
 
         self._get_issues(data)

release_notes_generator/model/commit_record.py

@@ -65,6 +65,9 @@ def to_chapter_row(self, add_into_chapters: bool = True) -> str:
 
         return row
 
+    def contains_change_increment(self) -> bool:
+        return True
+
     def get_rls_notes(self, line_marks: Optional[list[str]] = None) -> str:
         # Hint: direct commits does not support release notes
         return ""

release_notes_generator/model/hierarchy_issue_record.py

@@ -23,8 +23,8 @@ def __init__(self, issue: Issue, issue_labels: Optional[list[str]] = None, skip:
         super().__init__(issue, issue_labels, skip)
 
         self._level: int = 0
-        self._sub_issues: dict[int, SubIssueRecord] = {}
-        self._sub_hierarchy_issues: dict[int, "HierarchyIssueRecord"] = {}
+        self._sub_issues: dict[str, SubIssueRecord] = {}
+        self._sub_hierarchy_issues: dict[str, "HierarchyIssueRecord"] = {}
 
     @property
     def level(self) -> int:
@@ -120,7 +120,8 @@ def to_chapter_row(self, add_into_chapters: bool = True) -> str:
 
         # add sub-hierarchy issues
         for sub_hierarchy_issue in self._sub_hierarchy_issues.values():
-            row = f"{row}\n{sub_hierarchy_issue.to_chapter_row()}"
+            if sub_hierarchy_issue.contains_change_increment():
+                row = f"{row}\n{sub_hierarchy_issue.to_chapter_row()}"
 
         # add sub-issues
         if len(self._sub_issues) > 0:
@@ -129,6 +130,9 @@ def to_chapter_row(self, add_into_chapters: bool = True) -> str:
                 if sub_issue.is_open:
                     continue  # only closed issues are reported in release notes
 
+                if not sub_issue.contains_change_increment():
+                    continue  # skip sub-issues without change increment
+
                 sub_issue_block = "- " + sub_issue.to_chapter_row()
                 ind_child_block = "\n".join(
                     f"{sub_indent}{line}" if line else "" for line in sub_issue_block.splitlines()

release_notes_generator/model/issue_record.py

@@ -122,6 +122,9 @@ def to_chapter_row(self, add_into_chapters: bool = True) -> str:
 
         return row
 
+    def contains_change_increment(self) -> bool:
+        return self.pull_requests_count() > 0
+
     def get_rls_notes(self, line_marks: Optional[list[str]] = None) -> str:
         release_notes = ""
         detection_pattern = ActionInputs.get_release_notes_title()

release_notes_generator/model/mined_data.py

@@ -38,8 +38,8 @@
 class MinedData:
     """Class for keeping track of mined GitHub data."""
 
-    def __init__(self):
-        self.repository: Optional[Repository] = None
+    def __init__(self, repository: Repository):
+        self.repository: Repository = repository
         self.release: Optional[GitRelease] = None
         self.issues: list[Issue] = []
         self.pull_requests: list[PullRequest] = []
@@ -48,9 +48,9 @@ def __init__(self):
 
     def is_empty(self):
         """
-        Checks if the mined data is empty, meaning no repository has been set.
+        Check if the mined data is empty (no issues, pull requests, or commits).
 
         Returns:
-            bool: True if the repository is None, False otherwise.
+            bool: True if empty, False otherwise.
         """
-        return self.repository is None
+        return self.issues == [] and self.pull_requests == [] and self.commits == []

release_notes_generator/model/pull_request_record.py

@@ -128,6 +128,9 @@ def to_chapter_row(self, add_into_chapters: bool = True) -> str:
             row = f"{row}\n{self.get_rls_notes()}"
         return row
 
+    def contains_change_increment(self) -> bool:
+        return True
+
     def get_rls_notes(self, line_marks: Optional[list[str]] = None) -> str:
         release_notes = ""
         detection_pattern = ActionInputs.get_release_notes_title()

release_notes_generator/model/record.py

@@ -117,6 +117,15 @@ def to_chapter_row(self, add_into_chapters: bool = True) -> str:
             str: The string representation of the record in a chapter row.
         """
 
+    @abstractmethod
+    def contains_change_increment(self) -> bool:
+        """
+        Checks if the record contains a change increment.
+
+        Returns:
+            bool: True if the record contains a change increment, False otherwise.
+        """
+
     @abstractmethod
     def get_labels(self) -> list[str]:
         """