winipedia-utils 0.5.18__py3-none-any.whl → 0.5.22__py3-none-any.whl

winipedia_utils/git/github/workflows/base/base.py

@@ -243,6 +243,7 @@ class Workflow(YamlConfigFile):
             *cls.get_poetry_setup_steps(
                 install_dependencies=True,
                 repo_token=True,
+                with_keyring=True,
             ),
             cls.get_pre_commit_step(),
             cls.get_commit_step(),

winipedia_utils/git/github/workflows/release.py

@@ -3,10 +3,13 @@
 This workflow is used to create a release on GitHub.
 """
 
-from typing import Any
+from typing import TYPE_CHECKING, Any
 
 from winipedia_utils.git.github.workflows.health_check import HealthCheckWorkflow
 
+if TYPE_CHECKING:
+    from winipedia_utils.git.github.workflows.base.base import Workflow
+
 
 class ReleaseWorkflow(HealthCheckWorkflow):
     """Release workflow.
@@ -40,9 +43,10 @@ class ReleaseWorkflow(HealthCheckWorkflow):
     @classmethod
     def get_jobs(cls) -> dict[str, Any]:
         """Get the workflow jobs."""
-        jobs = HealthCheckWorkflow.get_jobs()
+        parent_cls: type[Workflow] = cls.__bases__[0]
+        jobs = parent_cls.get_jobs()
         release_job = cls.get_standard_job(
-            needs=[HealthCheckWorkflow.get_filename()],
+            needs=[parent_cls.get_filename()],
             steps=[
                 *cls.get_release_steps(),
             ],

{winipedia_utils-0.5.18.dist-info → winipedia_utils-0.5.22.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: winipedia-utils
-Version: 0.5.18
+Version: 0.5.22
 Summary: A package with many utility functions
 License-Expression: MIT
 License-File: LICENSE
@@ -105,7 +105,7 @@ The setup creates the following configuration files:
 - `.pre-commit-config.yaml` - Pre-commit hook configuration
 - `.gitignore` - Git ignore rules (assumes you added one on GitHub before.)
 - `pyproject.toml` - Project configuration with Poetry settings
-- `.github/workflows/health_check.yaml` - Health check workflow (Runs on every push and pull request, all workfows run on the latest possible python version in pyproject.toml)
+- `.github/workflows/health_check.yaml` - Health check workflow (Runs on every push and pull request using a matrix strategy to test across multiple operating systems and Python versions)
 - `.github/workflows/release.yaml` - Release workflow (Creates a release on GitHub when the same actions as in health check pass and commits are pushed to main)
 - `.github/workflows/publish.yaml` - Publishing workflow (Publishes to PyPI when a release is created by the release workflow, if you use this workflow, you need to add a PYPI_TOKEN (named PYPI_TOKEN) to your GitHub secrets that has write access to the package on PyPI.)
 - `py.typed` - PEP 561 marker for type hints
@@ -114,6 +114,38 @@ The setup creates the following configuration files:
 - `conftest.py` - Pytest configuration file
 - `.python-version` - Python version file for pyenv (if you use pyenv, puts in the lowest supported python version in pyproject.toml opposed to the latest possible python version in workflows)
 
+### GitHub Workflows and Matrix Strategy
+
+The project uses GitHub Actions workflows with a **matrix strategy** to ensure cross-platform compatibility:
+
+#### Matrix Configuration
+
+The health check and release workflows test your code across:
+- **Operating Systems**: Ubuntu (latest), Windows (latest), macOS (latest)
+- **Python Versions**: All versions specified in your `pyproject.toml` (e.g., 3.12, 3.13, 3.14)
+
+This matrix strategy ensures your code works reliably across different environments before merging or releasing.
+
+#### Workflow Structure
+
+The health check workflow consists of two jobs:
+
+1. **Matrix Job** (`health_check_matrix`) - Runs all checks in parallel across the matrix of OS and Python versions:
+   - Checkout repository
+   - Setup Git, Python, and Poetry
+   - Add Poetry to PATH (Windows-specific step)
+   - Install dependencies
+   - Setup CI keyring
+   - Protect repository (applies branch protection rules)
+   - Run pre-commit hooks (linting, formatting, type checking, security, tests)
+
+2. **Aggregation Job** (`health_check`) - Aggregates matrix results into a single status check:
+   - Required for branch protection compatibility
+   - Only runs after all matrix jobs complete successfully
+   - Provides a single status check that can be marked as required in branch protection rules
+
+The release workflow extends the health check workflow and adds a release job that runs after all health checks pass.
+
 ### Pre-commit Hook Workflow
 
 When you commit code using `git commit`, the following checks run automatically:
@@ -203,8 +235,8 @@ A ruleset named `main protection` is created for the `main` branch with the foll
   - Requires review thread resolution (all comments in reviews must be resolved before merge)
   - Allowed merge methods: `squash` and `rebase` (no merge commits, keeps history clean)
 - **Required Status Checks:**
-  - Strict mode enabled (all status checks must pass on the latest commit, not older ones (sets the health check as required status check))
-  - Health check workflow must pass (the CI/CD pipeline must complete successfully)
+  - Strict mode enabled (all status checks must pass on the latest commit, not older ones)
+  - Health check workflow must pass (the aggregated `health_check` job ensures all matrix combinations passed successfully)
 - **Bypass Actors** - Repository admins can bypass all rules (for emergency situations)
 
 ## Utilities

{winipedia_utils-0.5.18.dist-info → winipedia_utils-0.5.22.dist-info}/RECORD

@@ -16,10 +16,10 @@ winipedia_utils/git/github/repo/protect.py,sha256=nOVjb5GVinGIClp7k9_qqgKnAl_gk1
 winipedia_utils/git/github/repo/repo.py,sha256=OqoOfqDhe_Iik71dNqi4h3fGrMno33hSjk0bpNg3eZk,7865
 winipedia_utils/git/github/workflows/__init__.py,sha256=BPdntTwFEyBMJ6MyT7gddPHswvRdH9tsRtfK72VSV7Y,57
 winipedia_utils/git/github/workflows/base/__init__.py,sha256=XHsbmjiaGom-KX-S3leCY9cJD3aP9p_0X6xYMcdkHBU,23
-winipedia_utils/git/github/workflows/base/base.py,sha256=WowKcyrbDXwDs_GjJo1f3Vbfu2aWVhSqY-CTcknYl8w,12735
+winipedia_utils/git/github/workflows/base/base.py,sha256=K8Lb19clzaw35YCXHFJ7BVKqeI8bkqDtA-4aSjxl9LM,12770
 winipedia_utils/git/github/workflows/health_check.py,sha256=rSz3cV5xEgMIV-SaAjKBonucS_xqz1-t9FUDUbctRy8,2523
 winipedia_utils/git/github/workflows/publish.py,sha256=TPbSp5QH2vVl55UdqE_kjf1HIkdubcgqWlkLjWFX5EA,1378
-winipedia_utils/git/github/workflows/release.py,sha256=GkObB3LcH9J-L9dWhK5N3aowggGFu3kvmEFKHmILBu4,1456
+winipedia_utils/git/github/workflows/release.py,sha256=Vg87t_R-K9Ae-xQuvmGYi1nFhYfzgNVLu25EogfJwMw,1598
 winipedia_utils/git/gitignore/__init__.py,sha256=k-2E26JaZPkF69UUOJkpQl8T_PudrC7EYCIOxwgIQVU,57
 winipedia_utils/git/gitignore/config.py,sha256=Oi1gAf2mbR7vxMi0zsAFpCGzDaLNDd5S2vXEmA3eKg4,2595
 winipedia_utils/git/gitignore/gitignore.py,sha256=uE2MdynWgQuTG-y2YLR0FU5_giSE7s_TqSVQ6vnNOf8,2419
@@ -89,7 +89,7 @@ winipedia_utils/testing/tests/conftest.py,sha256=BLgUJtLecOwuEsIyJ__0buqovd5AhiG
 winipedia_utils/text/__init__.py,sha256=j2bwtK6kyeHI6SnoBjpRju0C1W2n2paXBDlNjNtaUxA,48
 winipedia_utils/text/config.py,sha256=jjKmn-tSbyaK6jGL0FxFHSREP6A6V1ZSX3RuIgvQ4io,7794
 winipedia_utils/text/string.py,sha256=yXmwOab5hXyVQG1NwlWDpy2prj0U7Vb2F5HKLT2Y77Q,3382
-winipedia_utils-0.5.18.dist-info/METADATA,sha256=gzcMByHCXrpz0mx9ExddW8Ju8XusI0exo2LZYthyxhM,14694
-winipedia_utils-0.5.18.dist-info/WHEEL,sha256=zp0Cn7JsFoX2ATtOhtaFYIiE2rmFAD4OcMhtUki8W3U,88
-winipedia_utils-0.5.18.dist-info/licenses/LICENSE,sha256=o316mE2gGzd__JT69p7S_zlOmKiHh8YjpImCCcWyTvM,1066
-winipedia_utils-0.5.18.dist-info/RECORD,,
+winipedia_utils-0.5.22.dist-info/METADATA,sha256=TlNzrKGVw6pJ8rQkK6-buqMdC2Dg4ozPXxsEgssWNEU,16129
+winipedia_utils-0.5.22.dist-info/WHEEL,sha256=zp0Cn7JsFoX2ATtOhtaFYIiE2rmFAD4OcMhtUki8W3U,88
+winipedia_utils-0.5.22.dist-info/licenses/LICENSE,sha256=o316mE2gGzd__JT69p7S_zlOmKiHh8YjpImCCcWyTvM,1066
+winipedia_utils-0.5.22.dist-info/RECORD,,