resolve conversation

Author: Jannis-Mittenzwei

.github/workflows/checks.yml

@@ -162,7 +162,7 @@ jobs:
 
   Build-Packages:
     name: Build Package Check
-    needs: [ Documentation, Lint, Type-Check, Security, Format, build-matrix ]
+    needs: [ Documentation, Lint, Type-Check, Security, Format ]
     runs-on: ubuntu-24.04
     permissions:
       contents: read
@@ -174,11 +174,11 @@ jobs:
         uses: ./.github/actions/python-environment
 
       - name: Run Distribution Check
-        run: poetry run -- nox -s lint:build-packages
+        run: poetry run -- nox -s package:check
 
   Tests:
     name: Unit-Tests (Python-${{ matrix.python-version }})
-    needs: [ Documentation, Lint, Type-Check, Security, Format, build-matrix , Build-Packages]
+    needs: [ Build-Packages ]
     runs-on: ubuntu-24.04
     permissions:
       contents: read

README.rst

@@ -47,7 +47,7 @@ Your one-stop solution for managing all standard tasks and core workflows of you
 🔌️ Prerequisites
 -----------------
 
-- `Python <https://www.python.org/`__ >= 3.9
+- `Python <https://www.python.org/>`__ >= 3.9
 
 💾 Installation
 ---------------

doc/changes/unreleased.md

@@ -29,4 +29,4 @@ PROJECT_CONFIG = Config(python_versions=(...), exasol_versions=(...), create_maj
 
 * #465: Created BaseConfig class to better synchronize attributes needed for the PTB's
   growing functionalities
-* #494: Created check of built packages with nox session ``package:check``:
+* #494: Created check of built packages with nox session `package:check`

exasol/toolbox/templates/github/workflows/checks.yml

@@ -162,7 +162,7 @@ jobs:
 
   Build-Packages:
     name: Build Package Check
-    needs: [ Documentation, Lint, Type-Check, Security, Format, build-matrix ]
+    needs: [ Documentation, Lint, Type-Check, Security, Format ]
     runs-on: ubuntu-24.04
     permissions:
       contents: read
@@ -174,11 +174,11 @@ jobs:
         uses: exasol/python-toolbox/.github/actions/python-environment@v1
 
       - name: Run Distribution Check
-        run: poetry run -- nox -s lint:build-packages
+        run: poetry run -- nox -s package:check
 
   Tests:
     name: Unit-Tests (Python-${{ matrix.python-version }})
-    needs: [ Documentation, Lint, Type-Check, Security, Format, build-matrix, Build-Packages ]
+    needs: [ Build-Packages ]
     runs-on: ubuntu-24.04
     permissions:
       contents: read

test/unit/nox/_package_check_test.py

@@ -1,14 +1,19 @@
-import pytest
+import shutil
+from pathlib import Path
 from unittest.mock import (
     MagicMock,
     patch,
 )
+
+import pytest
 from nox.command import CommandFailed
-import shutil
-from pathlib import Path
 
-from exasol.toolbox.nox._package import package_check, PROJECT_CONFIG
 from exasol.toolbox.config import BaseConfig
+from exasol.toolbox.nox._package import (
+    PROJECT_CONFIG,
+    package_check,
+)
+
 
 class TestDistributionCheck:
     @staticmethod
@@ -17,23 +22,23 @@ def test_works_as_expected(nox_session):
 
     @staticmethod
     def test_raises_non_zero_exist_with_readme_error(nox_session, tmp_path):
-        # TODOs
-        # 1. copy package files to a temp directory
-        # 2. mock/alter the path for the function you need to use for testing
-        # 3. modify rst file to have a broken link like is in this commit:
-        #     - `Python <https://www.python.org/`__ >= 3.9
         package = Path(tmp_path)
         package_readme = package / "README.rst"
+
+        # copy over `packages` and `include` from `pyproject.toml` to for `poetry build`
         shutil.copytree(PROJECT_CONFIG.root / "exasol", package / "exasol")
         shutil.copyfile(PROJECT_CONFIG.root / "README.rst", package_readme)
         shutil.copytree(PROJECT_CONFIG.root / "doc/changes", package / "doc/changes")
         shutil.copyfile(PROJECT_CONFIG.root / "LICENSE", package / "LICENSE")
-        shutil.copyfile(PROJECT_CONFIG.root / "pyproject.toml", package / "pyproject.toml")
-        old = "- `Python <https://www.python.org/>`__ >= 3.9"
-        error = "- `Python <https://www.python.org/>`__ >= 3.9"
-        readme = package_readme.read_text().splitlines()
-        error_readme = [error if old in line else line for line in readme]
-        package_readme.write_text("/n".join(error_readme))
+        shutil.copyfile(
+            PROJECT_CONFIG.root / "pyproject.toml", package / "pyproject.toml"
+        )
+
+        # create an error in readme.rst
+        not_closed_link_error = "- `Python <https://www.python.org/`__ >= 3.9"
+        package_readme.open(mode="a").write(not_closed_link_error)
+
+        # use of the folder with errors in the nox -s package:check function
         config = BaseConfig()
         mock = MagicMock(spec=BaseConfig, wraps=config)
         mock.root = package
@@ -42,4 +47,4 @@ def test_raises_non_zero_exist_with_readme_error(nox_session, tmp_path):
                 print(PROJECT_CONFIG.root)
                 package_check(nox_session)
         # verify broken with non-zero exit status
-        assert str(e.value) == "Returned code 1"
+        assert str(e.value) == "Returned code 1"