Several fixed after overtake of issue.

Author: miroslavpojer

.gitignore

@@ -159,4 +159,4 @@ cython_debug/
 .idea/
 
 default_output.txt
-run_localy.sh
+run_locally.sh

DEVELOPER.md

@@ -146,7 +146,7 @@ open htmlcov/index.html
 ```
 
 ## Run Action Locally
-Create *.sh file and place it in the project root.
+Create run_locally.sh file and place it in the project root.
 
 ```bash
 #!/bin/bash

release_notes_generator/action_inputs.py

@@ -336,7 +336,12 @@ def validate_inputs() -> None:
         else:
             ActionInputs._owner = ActionInputs._repo_name = ""
 
-        if not isinstance(ActionInputs._owner, str) or not ActionInputs._owner.strip() or not isinstance(ActionInputs._repo_name, str) or not ActionInputs._repo_name.strip():
+        if (
+            not isinstance(ActionInputs._owner, str)
+            or not ActionInputs._owner.strip()
+            or not isinstance(ActionInputs._repo_name, str)
+            or not ActionInputs._repo_name.strip()
+        ):
             errors.append("Owner and Repo must be a non-empty string.")
 
         tag_name = ActionInputs.get_tag_name()

release_notes_generator/filter.py

@@ -22,6 +22,7 @@
 
 logger = logging.getLogger(__name__)
 
+
 class Filter:
     """
     Base class for filtering records.
@@ -44,16 +45,21 @@ class FilterByRelease(Filter):
 
     def __init__(self, release_version: Optional[str] = None):
         self.release_version = release_version
+        # TODO - check usage of release_version, as it is not used in the current implementation
+        # it is also part of the MinedData class, so it might be redundant here
 
-    def filter(self, data: MinedData):
+    def filter(self, data: MinedData) -> MinedData:
         """
         Filters issues, pull requests, and commits based on the latest release date.
         If the release is not None, it filters out closed issues, merged pull requests, and commits
         that occurred before the release date.
-        @param data: The mined data containing issues, pull requests, commits, and release information.
-        @return: The filtered mined data.
-        """
 
+        @Parameters:
+        - data (MinedData): The mined data containing issues, pull requests, commits, and release information.
+
+        @Returns:
+        - MinedData: The filtered mined data with issues, pull requests, and commits reduced based on the release date.
+        """
         issues_list = data.issues
         pulls_list = data.pull_requests
         commits_list = data.commits
@@ -76,3 +82,5 @@ def filter(self, data: MinedData):
             data.commits = list(filter(lambda commit: commit.commit.author.date > data.since, commits_list))
             logger.debug("Count of commits reduced from %d to %d", len(commits_list), len(data.commits))
 
+        return data
+

release_notes_generator/generator.py

@@ -69,25 +69,25 @@ def generate(self, filterer: Filter) -> Optional[str]:
         """
         Generates the Release Notes for a given repository.
 
+        @Parameters:
+        - filterer: An instance of Filter that will be used to filter the mined data.
+
         @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)
         data = miner.mine_data()
         if data.is_empty():
             return None
 
-        filterer.filter(data=data)
+        filtered_data = filterer.filter(data=data)
 
         changelog_url: str = get_change_url(
-            tag_name=ActionInputs.get_tag_name(), repository=data.repository, git_release=data.release
+            tag_name=ActionInputs.get_tag_name(), repository=filtered_data.repository, git_release=filtered_data.release
         )
 
-        assert data.repository is not None, "Repository must not be None"
+        assert filtered_data.repository is not None, "Repository must not be None"
 
-        rls_notes_records: dict[int, Record] = RecordFactory.generate(
-            github=self._github_instance,
-            data=data
-        )
+        rls_notes_records: dict[int, Record] = RecordFactory.generate(github=self._github_instance, data=filtered_data)
 
         release_notes_builder = ReleaseNotesBuilder(
             records=rls_notes_records,

release_notes_generator/model/record.py

@@ -440,6 +440,7 @@ def is_pull_request_merged(pull: PullRequest) -> bool:
         """
         return pull.state == PR_STATE_CLOSED and pull.merged_at is not None and pull.closed_at is not None
 
+
 class PullRequestRecord(Record):
     """
     A class used to represent a pull request record in the release notes.
@@ -463,6 +464,7 @@ def __init__(self, issue: Issue, skip: bool = False):
         super().__init__(issue=issue, skip=skip)
         self.__is_release_note_detected = self.contains_release_notes
 
+
 class CommitRecord(Record):
     """
     A class used to represent a direct commit record in the release notes.
@@ -472,4 +474,4 @@ class CommitRecord(Record):
     def __init__(self, commit: Commit, skip: bool = False):
         super().__init__(issue=None, skip=skip)
         self.register_commit(commit)
-        self.__is_release_note_detected = self.contains_release_notes
+        self.__is_release_note_detected = self.contains_release_notes

release_notes_generator/record/record_factory.py

@@ -44,9 +44,7 @@ class RecordFactory:
     """
 
     @staticmethod
-    def generate(
-        github: Github, data: MinedData
-    ) -> dict[int, Record]:
+    def generate(github: Github, data: MinedData) -> dict[int, Record]:
         """
         Generate records for release notes.
 

release_notes_generator/utils/pull_request_utils.py

@@ -27,6 +27,7 @@
 from action_inputs import ActionInputs
 from release_notes_generator.utils.constants import ISSUES_FOR_PRS, LINKED_ISSUES_MAX
 
+
 ## todo romove
 def extract_issue_numbers_from_body(pr: PullRequest) -> list[int]:
     """
@@ -46,20 +47,25 @@ def extract_issue_numbers_from_body(pr: PullRequest) -> list[int]:
 
     return issue_numbers
 
+
 @lru_cache(maxsize=None)
 def get_issues_for_pr(pull_number: int) -> list[int]:
     """Update the placeholder values and formate the graphQL query"""
     github_api_url = "https://api.github.com/graphql"
-    query = ISSUES_FOR_PRS.format(number=pull_number,
-                                 owner=ActionInputs.get_github_owner(),
-                                 name=ActionInputs.get_github_repo_name(),
-                                 first=LINKED_ISSUES_MAX)
+    query = ISSUES_FOR_PRS.format(
+        number=pull_number,
+        owner=ActionInputs.get_github_owner(),
+        name=ActionInputs.get_github_repo_name(),
+        first=LINKED_ISSUES_MAX,
+    )
     headers = {
         "Authorization": f"Bearer {ActionInputs.get_github_token()}",
         "Content-Type": "application/json",
     }
     response = requests.post(github_api_url, json={"query": query}, headers=headers)
     response.raise_for_status()  # Raise an error for HTTP issues
-    numbers = [node['number'] for node in response.json()['data']['repository']['pullRequest']['closingIssuesReferences']['nodes']]
+    numbers = [
+        node["number"]
+        for node in response.json()["data"]["repository"]["pullRequest"]["closingIssuesReferences"]["nodes"]
+    ]
     return numbers
-

tests/test_filter.py

@@ -84,4 +84,4 @@ def test_filter_with_release(mocker):
     assert ('Starting issue, prs and commit reduction by the latest release since time.',) == mock_log_info.call_args_list[0][0]
     assert ('Count of issues reduced from %d to %d', 2, 1) == mock_log_debug.call_args_list[0][0]
     assert ('Count of pulls reduced from %d to %d', 2, 1) == mock_log_debug.call_args_list[1][0]
-    assert ('Count of commits reduced from %d to %d', 2, 1) == mock_log_debug.call_args_list[2][0]
+    assert ('Count of commits reduced from %d to %d', 2, 1) == mock_log_debug.call_args_list[2][0]