winipedia-utils 0.2.25__tar.gz → 0.2.47__tar.gz

{winipedia_utils-0.2.25 → winipedia_utils-0.2.47}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: winipedia-utils
-Version: 0.2.25
+Version: 0.2.47
 Summary: A package with many utility functions
 License-Expression: MIT
 License-File: LICENSE
@@ -126,7 +126,13 @@ Adds tool configurations in pyproject.toml for e.g.:
 - **pytest** - Test discovery and execution
 - **bandit** - Security scanning
 
-### Step 6️⃣ - Create GitHub Actions Workflow
+### Step 6️⃣ - Create GitHub Actions Workflows
+Sets up `.github/workflows/release.yaml` for automated versioning and publishing:
+- Triggers on pushing tags in the form of v*
+- Creates a release on GitHub
+- Triggers publish.yaml workflow if publish.yaml exists
+- Tests will fail if you do not have release.yaml
+
 Sets up `.github/workflows/publish.yaml` for automated PyPI publishing:
 - Triggers on GitHub releases
 - Configures Poetry with PyPI token

{winipedia_utils-0.2.25 → winipedia_utils-0.2.47}/README.md

@@ -102,7 +102,13 @@ Adds tool configurations in pyproject.toml for e.g.:
 - **pytest** - Test discovery and execution
 - **bandit** - Security scanning
 
-### Step 6️⃣ - Create GitHub Actions Workflow
+### Step 6️⃣ - Create GitHub Actions Workflows
+Sets up `.github/workflows/release.yaml` for automated versioning and publishing:
+- Triggers on pushing tags in the form of v*
+- Creates a release on GitHub
+- Triggers publish.yaml workflow if publish.yaml exists
+- Tests will fail if you do not have release.yaml
+
 Sets up `.github/workflows/publish.yaml` for automated PyPI publishing:
 - Triggers on GitHub releases
 - Configures Poetry with PyPI token

{winipedia_utils-0.2.25 → winipedia_utils-0.2.47}/pyproject.toml

@@ -1,7 +1,7 @@
 # Project section
 [project]
 name = "winipedia-utils"
-version = "0.2.25"
+version = "0.2.47"
 description = "A package with many utility functions"
 readme = "README.md"
 requires-python = ">=3.12"

winipedia_utils-0.2.47/winipedia_utils/git/workflows/base/base.py

@@ -0,0 +1,47 @@
+"""Contains base utilities for git workflows."""
+
+from typing import Any
+
+
+def _get_checkout_step(fetch_depth: int | None = None) -> dict[str, Any]:
+    """Get the checkout step."""
+    step: dict[str, Any] = {
+        "name": "Checkout repository",
+        "uses": "actions/checkout@v5",
+    }
+    if fetch_depth is not None:
+        step["with"] = {"fetch-depth": fetch_depth}
+    return step
+
+
+def _get_poetry_setup_steps(
+    *,
+    install_dependencies: bool = False,
+    fetch_depth: int | None = None,
+    configure_pipy_token: bool = False,
+) -> list[dict[str, Any]]:
+    """Get the poetry steps."""
+    steps = [_get_checkout_step(fetch_depth)]
+    steps.append(
+        {
+            "name": "Setup Python",
+            "uses": "actions/setup-python@v6",
+            "with": {"python-version": "3.x"},
+        }
+    )
+    steps.append(
+        {
+            "name": "Install Poetry",
+            "run": "curl -sSL https://install.python-poetry.org | python3 -",
+        }
+    )
+    if configure_pipy_token:
+        steps.append(
+            {
+                "name": "Configure Poetry",
+                "run": "poetry config pypi-token.pypi ${{ secrets.PYPI_TOKEN }}",
+            }
+        )
+    if install_dependencies:
+        steps.append({"name": "Install Dependencies", "run": "poetry install"})
+    return steps

{winipedia_utils-0.2.25 → winipedia_utils-0.2.47}/winipedia_utils/git/workflows/publish.py

@@ -8,6 +8,9 @@ from typing import Any
 
 import yaml
 
+from winipedia_utils.git.workflows.base.base import _get_poetry_setup_steps
+from winipedia_utils.git.workflows.release import WORKFLOW_NAME
+
 PUBLISH_WORKFLOW_PATH = Path(".github/workflows/publish.yaml")
 
 
@@ -31,22 +34,23 @@ def _get_publish_config() -> dict[str, Any]:
     """Dict that represents the publish workflow yaml."""
     return {
         "name": "Publish to PyPI",
-        "on": {"release": {"types": ["published"]}},
+        "on": {
+            "workflow_run": {
+                "workflows": [WORKFLOW_NAME],
+                "types": ["completed"],
+                "branches": ["main"],
+            },
+            "release": {"types": ["published"]},
+        },
         "jobs": {
             "publish": {
                 "runs-on": "ubuntu-latest",
                 "steps": [
-                    {"name": "Checkout repository", "uses": "actions/checkout@v4"},
-                    {
-                        "name": "Set up Python",
-                        "uses": "actions/setup-python@v5",
-                        "with": {"python-version": "3.x"},
-                    },
-                    {"name": "Install Poetry", "run": "pip install poetry"},
-                    {
-                        "name": "Configure Poetry",
-                        "run": "poetry config pypi-token.pypi ${{ secrets.PYPI_TOKEN }}",  # noqa: E501
-                    },
+                    *(
+                        _get_poetry_setup_steps(
+                            configure_pipy_token=True,
+                        )
+                    ),
                     {
                         "name": "Build and publish to PyPI",
                         "run": "poetry publish --build",

winipedia_utils-0.2.47/winipedia_utils/git/workflows/release.py

@@ -0,0 +1,88 @@
+"""Contains the release workflow.
+
+This workflow is used to create a release on GitHub.
+"""
+
+from pathlib import Path
+from typing import Any
+
+import yaml
+
+from winipedia_utils.git.workflows.base.base import _get_poetry_setup_steps
+
+RELEASE_WORKFLOW_PATH = Path(".github/workflows/release.yaml")
+
+WORKFLOW_NAME = "Create Release"
+
+
+def load_release_workflow() -> dict[str, Any]:
+    """Load the release workflow."""
+    path = RELEASE_WORKFLOW_PATH
+    if not path.exists():
+        path.parent.mkdir(parents=True, exist_ok=True)
+        path.touch()
+    return yaml.safe_load(path.read_text()) or {}
+
+
+def dump_release_workflow(config: dict[str, Any]) -> None:
+    """Dump the release workflow."""
+    path = RELEASE_WORKFLOW_PATH
+    with path.open("w") as f:
+        yaml.safe_dump(config, f, sort_keys=False)
+
+
+def _get_release_config() -> dict[str, Any]:
+    """Dict that represents the release workflow yaml."""
+    return {
+        "name": WORKFLOW_NAME,
+        "on": {"push": {"tags": ["v*"], "branches": ["main"]}},
+        "permissions": {
+            "contents": "write",
+        },
+        "jobs": {
+            "release": {
+                "runs-on": "ubuntu-latest",
+                "steps": [
+                    *(
+                        _get_poetry_setup_steps(
+                            install_dependencies=True,
+                            fetch_depth=0,
+                        )
+                    ),
+                    {
+                        "name": "Run Pre-commit Hooks",
+                        "run": "poetry run pre-commit run --all-files",
+                    },
+                    {
+                        "name": "Build Changelog",
+                        "id": "build_changelog",
+                        "uses": "mikepenz/release-changelog-builder-action@v5",
+                        "with": {"token": "${{ secrets.GITHUB_TOKEN }}"},
+                    },
+                    {
+                        "name": "Create GitHub Release",
+                        "uses": "ncipollo/release-action@v1",
+                        "with": {
+                            "tag": "${{ github.ref_name }}",
+                            "name": "${{ github.event.repository.name }}-${{ github.ref_name }}",  # noqa: E501
+                            "body": "${{ steps.build_changelog.outputs.changelog }}",
+                        },
+                    },
+                ],
+            }
+        },
+    }
+
+
+def _release_config_is_correct() -> bool:
+    """Check if the release workflow is correct."""
+    config = load_release_workflow()
+    return bool(config == _get_release_config())
+
+
+def _add_release_workflow() -> None:
+    """Add the release workflow."""
+    if _release_config_is_correct():
+        return
+    config = _get_release_config()
+    dump_release_workflow(config)

winipedia_utils-0.2.47/winipedia_utils/resources/svgs/__init__.py

@@ -0,0 +1 @@
+"""__init__ module."""

{winipedia_utils-0.2.25 → winipedia_utils-0.2.47}/winipedia_utils/setup.py

@@ -16,6 +16,7 @@ from winipedia_utils.git.pre_commit.config import (
 )
 from winipedia_utils.git.pre_commit.run_hooks import _run_all_hooks
 from winipedia_utils.git.workflows.publish import _add_publish_workflow
+from winipedia_utils.git.workflows.release import _add_release_workflow
 from winipedia_utils.logging.logger import get_logger
 from winipedia_utils.projects.poetry.config import (
     _add_configurations_to_pyproject_toml,
@@ -33,6 +34,7 @@ SETUP_STEPS = [
     _add_package_hook_to_pre_commit_config,
     _pre_commit_install,
     _add_package_patterns_to_gitignore,
+    _add_release_workflow,
     _add_publish_workflow,
     _add_configurations_to_pyproject_toml,
     _create_project_root,

{winipedia_utils-0.2.25 → winipedia_utils-0.2.47}/winipedia_utils/testing/assertions.py

@@ -5,6 +5,8 @@ assert statement with additional features like improved error messages and
 specialized validation logic for common testing scenarios.
 """
 
+from typing import Any
+
 
 def assert_with_msg(expr: bool, msg: str) -> None:  # noqa: FBT001
     """Assert that an expression is true with a custom error message.
@@ -21,3 +23,26 @@ def assert_with_msg(expr: bool, msg: str) -> None:  # noqa: FBT001
 
     """
     assert expr, msg  # noqa: S101  # nosec: B101
+
+
+def assert_with_info(expr: bool, expected: Any, actual: Any, msg: str = "") -> None:  # noqa: FBT001
+    """Assert that an expression is true with a custom error message.
+
+    wraps around assert with msg and adds the expected and actual values to the message.
+
+    Args:
+        expr: The expression to evaluate for truthiness
+        expected: The expected value
+        actual: The actual value
+        msg: The error message to display if the assertion fails
+
+    Raises:
+        AssertionError: If the expression evaluates to False
+
+    """
+    msg = f"""
+Expected: {expected}
+Actual: {actual}
+{msg}
+"""
+    assert_with_msg(expr, msg)

{winipedia_utils-0.2.25 → winipedia_utils-0.2.47}/winipedia_utils/testing/tests/base/fixtures/scopes/session.py

@@ -18,6 +18,7 @@ from winipedia_utils.git.workflows.publish import (
     PUBLISH_WORKFLOW_PATH,
     _publish_config_is_correct,
 )
+from winipedia_utils.git.workflows.release import _release_config_is_correct
 from winipedia_utils.modules.module import to_path
 from winipedia_utils.modules.package import (
     find_packages,
@@ -185,6 +186,18 @@ def _test_publish_workflow_is_correct() -> None:
     )
 
 
+@autouse_session_fixture
+def _test_release_workflow_is_correct() -> None:
+    """Verify that the release workflow is correctly defined.
+
+    This workflow is mandatory for all projects.
+    """
+    assert_with_msg(
+        _release_config_is_correct(),
+        "Release workflow is not correct.",
+    )
+
+
 @autouse_session_fixture
 def _test_no_namespace_packages() -> None:
     """Verify that there are no namespace packages in the project.