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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: winipedia-utils
-Version: 0.2.47
+Version: 0.2.50
 Summary: A package with many utility functions
 License-Expression: MIT
 License-File: LICENSE

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

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

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

@@ -0,0 +1,84 @@
+"""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.
+
+    Args:
+        fetch_depth: The fetch depth to use. If None, no fetch depth is specified.
+
+    Returns:
+        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,
+    force_main_head: bool = False,
+) -> list[dict[str, Any]]:
+    """Get the poetry steps.
+
+    Args:
+        install_dependencies: Whether to install dependencies.
+        fetch_depth: The fetch depth to use. If None, no fetch depth is specified.
+        configure_pipy_token: Whether to configure the pipy token.
+        force_main_head: Whether to exit if the running branch or current commit is not
+            equal to the most recent commit on main. This is useful for workflows that
+            should only run on main.
+
+    Returns:
+        The poetry steps.
+    """
+    steps = [_get_checkout_step(fetch_depth)]
+    if force_main_head:
+        # exit with code 1 if the running branch is not main
+        steps.append(
+            {
+                "name": "Assert running on head of main",
+                "run": """|
+git fetch origin main --depth=1
+main_sha=$(git rev-parse origin/main)
+if [ "$GITHUB_SHA" != "$main_sha" ]; then
+echo "Tag commit is not the latest commit on main."
+exit 1
+fi
+""",
+            }
+        )
+    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.47 → winipedia_utils-0.2.50}/winipedia_utils/git/workflows/publish.py

@@ -38,9 +38,7 @@ def _get_publish_config() -> dict[str, Any]:
             "workflow_run": {
                 "workflows": [WORKFLOW_NAME],
                 "types": ["completed"],
-                "branches": ["main"],
             },
-            "release": {"types": ["published"]},
         },
         "jobs": {
             "publish": {

{winipedia_utils-0.2.47 → winipedia_utils-0.2.50}/winipedia_utils/git/workflows/release.py

@@ -35,7 +35,7 @@ def _get_release_config() -> dict[str, Any]:
     """Dict that represents the release workflow yaml."""
     return {
         "name": WORKFLOW_NAME,
-        "on": {"push": {"tags": ["v*"], "branches": ["main"]}},
+        "on": {"push": {"tags": ["v*"]}},
         "permissions": {
             "contents": "write",
         },
@@ -47,6 +47,7 @@ def _get_release_config() -> dict[str, Any]:
                         _get_poetry_setup_steps(
                             install_dependencies=True,
                             fetch_depth=0,
+                            force_main_head=True,
                         )
                     ),
                     {

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

@@ -1,47 +0,0 @@
-"""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