docs: Update changelog to address mdformat issues

.pre-commit-config.yaml

@@ -4,7 +4,13 @@ default_stages: [pre-commit]
 ci:
   autofix_prs: false
   autoupdate_schedule: weekly
-  skip: [check-poetry, pyright, poetry-audit, markdown-link-check]
+  autoupdate_commit_msg: 'chore(pre-commit-deps): pre-commit autoupdate'
+  skip:
+    - check-poetry
+    - pylint
+    - pyright
+    - poetry-audit
+    - markdown-link-check
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: 2c9f875913ee60ca25ce70243dc24d5b6415598c  # frozen: v4.6.0
@@ -60,7 +66,7 @@ repos:
     hooks:
       - id: blacken-docs
         files: \.(rst|md|markdown|tex)$
-        additional_dependencies: [black==24.4.2]  # This may need to be updated/removed in the future once ruff supports formatting Python code blocks in markdown
+        additional_dependencies: [black==24.8.0]  # This may need to be updated/removed in the future once ruff supports formatting Python code blocks in markdown
         args: [--line-length=100]
   - repo: https://github.com/lyz-code/yamlfix
     rev: 8072181c0f2eab9f2dd8db2eb3b9556d7cd0bd74  # frozen: 1.17.0
@@ -107,6 +113,13 @@ repos:
       - id: toml-sort-fix
   - repo: local
     hooks:
+      - id: pylint
+        name: pylint
+        entry: pylint
+        language: system
+        types: [python]
+        pass_filenames: true
+        args: [-sn]
       - id: pyright
         name: pyright
         entry: pyright

CHANGELOG.md

@@ -38,7 +38,7 @@ Things to be included in the next release go here.
 - chore(python-deps): update dependency pyright to v1.1.382.post1 for dev ([#132](https://github.com/tektronix/python-package-ci-cd/pull/132))
 - chore(docker-deps): update python:3.12-alpine docker digest to e75de17 in all dependant actions ([#130](https://github.com/tektronix/python-package-ci-cd/pull/130))
 - chore(docker-deps): update python:3.12-alpine docker digest to 6666ea3 in all dependant actions ([#129](https://github.com/tektronix/python-package-ci-cd/pull/129))
-- [pre-commit.ci] pre-commit autoupdate ([#117](https://github.com/tektronix/python-package-ci-cd/pull/117))
+- chore(pre-commit-deps): pre-commit autoupdate ([#117](https://github.com/tektronix/python-package-ci-cd/pull/117))
 - chore(python-deps): update dependency pyright to v1.1.382.post0 for dev ([#125](https://github.com/tektronix/python-package-ci-cd/pull/125))
 - chore(python-deps): update dependency pyright to v1.1.382 for dev ([#124](https://github.com/tektronix/python-package-ci-cd/pull/124))
 - chore(gh-actions-deps): update github/codeql-action action to v3.26.9 in all dependant reusable workflows ([#123](https://github.com/tektronix/python-package-ci-cd/pull/123))

actions/create_unique_testpypi_version/main.py

@@ -87,7 +87,7 @@ def main() -> None:
         tomli_w.dump(pyproject_data, file_handle)
 
     # Set the output variable for GitHub Actions
-    with open(os.environ["GITHUB_OUTPUT"], "a") as github_output_file_handle:  # noqa: PTH123
+    with open(os.environ["GITHUB_OUTPUT"], "a", encoding="utf-8") as github_output_file_handle:  # noqa: PTH123
         github_output_file_handle.write(f"new-version={updated_version}\n")
 
 

actions/find_unreleased_changelog_items/main.py

@@ -63,82 +63,82 @@
     return run_cmd_in_subprocess(f"git log {range_spec} --pretty=format:%s").splitlines()
 
 
-def main() -> None:
+def main() -> None:  # pylint: disable=too-many-locals
     """Check for entries in the Unreleased section of the CHANGELOG.md file.
 
     Raises:
         SystemExit: Indicates no new entries were found.
     """
     # Load in the GitHub Action inputs
     # See https://docs.github.com/en/actions/sharing-automations/creating-actions/metadata-syntax-for-github-actions#example-specifying-inputs
     filepath_for_previous_changelog = os.environ["INPUT_PREVIOUS-CHANGELOG-FILEPATH"]
     filepath_for_previous_release_notes = os.environ["INPUT_PREVIOUS-RELEASE-NOTES-FILEPATH"]
     release_level = os.getenv("INPUT_RELEASE-LEVEL")
     # Set the filepaths for the template files
     template_changelog_filepath = pathlib.Path(filepath_for_previous_changelog)
     template_release_notes_filepath = pathlib.Path(filepath_for_previous_release_notes)
     root_dir = pathlib.Path.cwd()
 
     release_notes_content = ""
     found_entries = False
     with CHANGELOG_FILE.open(mode="r", encoding="utf-8") as changelog_file:
         tracking_unreleased = False
         tracking_entries = False
         for line in changelog_file:
             if line.startswith(("___", "---")):
                 tracking_unreleased = False
                 tracking_entries = False
             if line.startswith("## Unreleased"):
                 tracking_unreleased = True
             if tracking_unreleased:
                 release_notes_content += line
             if tracking_unreleased and line.startswith(
                 (
                     "### Added\n",
                     "### Changed\n",
                     "### Deprecated\n",
                     "### Removed\n",
                     "### Fixed\n",
                     "### Security\n",
                 )
             ):
                 tracking_entries = True
             if tracking_entries and not found_entries:
                 found_entries = bool(re.match(r"^- \w+", line))
 
     if not found_entries:
         msg = f"No unreleased entries were found in {CHANGELOG_FILE}."
         raise SystemExit(msg)
 
     # Check for merged PRs since the last release
     run_cmd_in_subprocess(
         f'git config --global --add safe.directory "{root_dir.resolve().as_posix()}"'
     )
     commit_messages = get_commit_messages(since_tag=get_latest_tag())
     pr_regex = re.compile(r"\(#\d+\)$")
     pr_descriptions = "\n".join([f"- {msg}" for msg in commit_messages if pr_regex.search(msg)])
     if not pr_descriptions and not os.getenv("UNIT_TESTING_FIND_UNRELEASED_CHANGELOG_ITEMS_ACTION"):
         msg = "No PRs have been merged since the last release."
         raise SystemExit(msg)
 
     # Copy the files to the correct location
     shutil.copy(CHANGELOG_FILE, template_changelog_filepath)
     with template_release_notes_filepath.open("w", encoding="utf-8") as template_release_notes:
         template_release_notes.write(release_notes_content.strip() + "\n")
 
     # If running in GitHub Actions, and the release_level is set, send the release level and
     # incoming changes to the GitHub Summary
     if release_level:
         summary_contents = (
             f"## Workflow Inputs\n- release-level: {release_level}\n"
             f"## PRs Merged Since Last Release\n{pr_descriptions}\n"
             f"## Incoming Changes\n{release_notes_content.replace('## Unreleased', '').strip()}\n"
         )
         print(
             f"\nAdding the following contents to the GitHub Workflow Summary:\n\n{summary_contents}"
         )
-        with open(os.environ["GITHUB_STEP_SUMMARY"], "a") as summary_file:  # noqa: PTH123
+        with open(os.environ["GITHUB_STEP_SUMMARY"], "a", encoding="utf-8") as summary_file:  # noqa: PTH123
             summary_file.write(summary_contents)
 
 
 if __name__ == "__main__":  # pragma: no cover

pyproject.toml

@@ -54,6 +54,7 @@ poetry-audit-plugin = "^0.4.0"
 poetry-plugin-export = "1.8.0"
 poetry-pre-commit-plugin = "^0.1.2"
 pre-commit = "3.8.0"
+pylint = "3.3.1"
 pyright = "1.1.383"
 tox = "^4.18.0"
 tox-gh-actions = "^3.2.0"
@@ -83,6 +84,78 @@ pytest-html = "^4.1.1"
 pytest-order = "^1.2.1"
 pytest-subprocess = "^1.5.2"
 
+[tool.pylint.main]
+fail-under = 10.0
+ignore-patterns = [
+  "^\\.#",
+  "^\\..*_cache",
+  "^\\.docs.*",
+  "^\\.env.*",
+  "^\\.idea",
+  "^\\.results.*",
+  "^\\.tox",
+  "^\\.venv.*",
+  "^\\.vscode",
+  "^temp_.*\\..*"
+]
+init-hook = 'import sys; sys.path.append(".")'
+jobs = 0
+load-plugins = """
+pylint.extensions.check_elif,
+pylint.extensions.code_style,
+pylint.extensions.comparison_placement,
+pylint.extensions.consider_refactoring_into_while_condition,
+pylint.extensions.dict_init_mutate,
+pylint.extensions.docparams,
+pylint.extensions.docstyle,
+pylint.extensions.dunder,
+pylint.extensions.eq_without_hash,
+pylint.extensions.for_any_all,
+pylint.extensions.no_self_use,
+pylint.extensions.overlapping_exceptions,
+pylint.extensions.private_import,
+pylint.extensions.set_membership,
+pylint.extensions.typing,
+pylint.extensions.while_used
+"""
+recursive = true
+
+[tool.pylint."messages control"]
+disable = [
+  "broad-exception-caught",  # caught by ruff
+  "fixme",  # caught by ruff
+  "global-statement",  # caught by ruff
+  "invalid-name",  # caught by ruff
+  "line-too-long",  # caught by ruff
+  "locally-disabled",  # allowed
+  "missing-class-docstring",  # caught by ruff
+  "missing-module-docstring",  # caught by ruff
+  "no-member",  # caught by pyright
+  "protected-access",  # caught by ruff
+  "raise-missing-from",  # caught by ruff
+  "redefined-builtin",  # caught by ruff
+  "suppressed-message",  # allowed
+  "too-many-arguments",  # caught by ruff
+  "too-many-branches",  # caught by ruff
+  "too-many-statements",  # caught by ruff
+  "too-many-statements",  # caught by ruff
+  "unused-argument",  # caught by ruff
+  "unused-import",  # caught by ruff
+  "use-implicit-booleaness-not-comparison-to-string",  # caught by ruff
+  "wrong-import-order"  # caught by ruff
+]
+enable = ["all"]
+
+[tool.pylint.reports]
+# Python expression which should return a score less than or equal to 10. You
+# have access to the variables 'fatal', 'error', 'warning', 'refactor',
+# 'convention', and 'info' which contain the number of messages in each category,
+# as well as 'statement' which is the total number of statements analyzed. This
+# score is used by the global evaluation report (RP0004).
+evaluation = "max(0, 0 if fatal else 10.0 - ((float(5 * error + warning + refactor + convention + info) / statement) * 10))"
+output-format = "text"  # colorized could be another option
+score = true
+
 [tool.pyright]
 ignore = [
   "temp_*.py"

tests/test_bump_version_in_files.py

@@ -1,7 +1,7 @@
 """Test the bump_version_in_files module."""
 
+from collections.abc import Generator
 from pathlib import Path
-from typing import Generator
 from unittest.mock import MagicMock, patch
 
 import pytest
@@ -10,14 +10,14 @@
 
 
 @pytest.fixture(autouse=True)
-def mock_subprocess_check_call() -> Generator[None, None, None]:
+def mock_subprocess_check_call() -> Generator[None]:
     """Mock subprocess.check_call for all tests."""
     with patch("subprocess.check_call", MagicMock(return_value=None)):
         yield
 
 
-@pytest.fixture()
-def temporary_directory(tmp_path: Path) -> Path:
+@pytest.fixture(name="temporary_directory")
+def fixture_temporary_directory(tmp_path: Path) -> Path:
     """Create a temporary directory."""
     # Create a temporary directory with some files
     test_dir = tmp_path / "test_dir"

tests/test_create_unique_testpypi_version.py

@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from typing import Generator, TYPE_CHECKING
+from typing import TYPE_CHECKING
 from unittest.mock import MagicMock, patch
 
 import pytest
@@ -12,6 +12,7 @@
 from actions.create_unique_testpypi_version.main import create_new_post_version, main
 
 if TYPE_CHECKING:
+    from collections.abc import Generator
     from pathlib import Path
 
 # Sample data for mocking
@@ -32,8 +33,8 @@ def _mock_environment(monkeypatch: pytest.MonkeyPatch) -> None:  # pyright: igno
     monkeypatch.setenv("INPUT_PACKAGE-NAME", PACKAGE_NAME)
 
 
-@pytest.fixture()
-def mock_testpypi_server() -> Generator[MagicMock, None, None]:
+@pytest.fixture(name="mock_testpypi_server")
+def fixture_mock_testpypi_server() -> Generator[MagicMock]:
     """Mock the PyPISimple class and its methods."""
     with patch("actions.create_unique_testpypi_version.main.PyPISimple") as mock_pypi_simple:
         mock_server = mock_pypi_simple.return_value
@@ -43,8 +44,8 @@ def mock_testpypi_server() -> Generator[MagicMock, None, None]:
         yield mock_server
 
 
-@pytest.fixture()
-def mock_pyproject_file(tmp_path: Path, monkeypatch: pytest.MonkeyPatch) -> Path:
+@pytest.fixture(name="mock_pyproject_file")
+def fixture_mock_pyproject_file(tmp_path: Path, monkeypatch: pytest.MonkeyPatch) -> Path:
     """Mock the pyproject.toml file.
 
     Args:
@@ -63,8 +64,8 @@ def mock_pyproject_file(tmp_path: Path, monkeypatch: pytest.MonkeyPatch) -> Path
     return pyproject_file
 
 
-@pytest.fixture()
-def mock_github_output_file(tmp_path: Path, monkeypatch: pytest.MonkeyPatch) -> Path:
+@pytest.fixture(name="mock_github_output_file")
+def fixture_mock_github_output_file(tmp_path: Path, monkeypatch: pytest.MonkeyPatch) -> Path:
     """Mock the GitHub output file.
 
     Args:

tests/test_docs.py

@@ -6,17 +6,17 @@
 import sys
 import time
 
+from collections.abc import Generator
 from importlib.util import find_spec
 from pathlib import Path
-from typing import Generator
 
 import pytest
 
 REPO_ROOT_DIR = Path(__file__).resolve().parent.parent
 
 
 @pytest.fixture(name="docs_server")
-def fixture_docs_server(site_dir: str) -> Generator[str, None, None]:
+def fixture_docs_server(site_dir: str) -> Generator[str]:
     """Serve the documentation site."""
     port = f"8{sys.version_info.major}{sys.version_info.minor}"
     cmd = [sys.executable, "-m", "http.server", port, "--directory", site_dir]
@@ -49,7 +49,7 @@ def fixture_site_dir(pytestconfig: pytest.Config) -> str:
 
 
 @pytest.fixture(scope="module", autouse=True)
-def _docs_tests_setup() -> Generator[None, None, None]:  # pyright: ignore [reportUnusedFunction]
+def _docs_tests_setup() -> Generator[None]:  # pyright: ignore [reportUnusedFunction]
     """Setup for docs tests.."""
     starting_directory = Path.cwd()
     try:

tests/test_find_unreleased_changelog_items.py

@@ -22,8 +22,8 @@
 MOCK_TEMPLATES_FOLDER = "mock_templates"
 
 
-@pytest.fixture()
-def mock_previous_files(tmp_path: Path) -> tuple[Path, Path]:
+@pytest.fixture(name="mock_previous_files")
+def fixture_mock_previous_files(tmp_path: Path) -> tuple[Path, Path]:
     """Create filepaths in the temporary directory for the template files.
 
     Args:
@@ -40,8 +40,8 @@ def mock_previous_files(tmp_path: Path) -> tuple[Path, Path]:
     )
 
 
-@pytest.fixture()
-def mock_changelog_file(monkeypatch: pytest.MonkeyPatch, tmp_path: Path) -> Path:
+@pytest.fixture(name="mock_changelog_file")
+def fixture_mock_changelog_file(monkeypatch: pytest.MonkeyPatch, tmp_path: Path) -> Path:
     """Mock the pyproject.toml file.
 
     Args:
@@ -63,8 +63,8 @@ def mock_changelog_file(monkeypatch: pytest.MonkeyPatch, tmp_path: Path) -> Path
     return mock_path
 
 
-@pytest.fixture()
-def summary_file(tmp_path: Path) -> Path:
+@pytest.fixture(name="summary_file")
+def fixture_summary_file(tmp_path: Path) -> Path:
     """Create a summary file for the GitHub Actions step.
 
     Args:
@@ -76,8 +76,8 @@ def summary_file(tmp_path: Path) -> Path:
     return tmp_path / "github_summary.txt"
 
 
-@pytest.fixture()
-def mock_env_vars(
+@pytest.fixture(name="mock_env_vars")
+def fixture_mock_env_vars(
     tmp_path: Path,
     monkeypatch: pytest.MonkeyPatch,
     summary_file: Path,

tests/test_update_development_dependencies.py

@@ -2,8 +2,8 @@
 
 import sys
 
+from collections.abc import Generator
 from pathlib import Path
-from typing import Generator
 from unittest.mock import call, MagicMock, patch
 
 import pytest
@@ -21,7 +21,7 @@
 
 
 @pytest.fixture(autouse=True)
-def mock_pypi_server() -> Generator[MagicMock, None, None]:
+def mock_pypi_server() -> Generator[MagicMock]:
     """Mock the PyPISimple class and its methods."""
     with patch("actions.update_development_dependencies.main.PyPISimple") as mock_pypi_simple:
         mock_server = mock_pypi_simple.return_value
@@ -31,8 +31,8 @@ def mock_pypi_server() -> Generator[MagicMock, None, None]:
         yield mock_server
 
 
-@pytest.fixture()
-def repo_root_dir(
+@pytest.fixture(name="repo_root_dir")
+def fixture_repo_root_dir(
     monkeypatch: pytest.MonkeyPatch,
     tmp_path: Path,
 ) -> Path: