winipedia-utils 0.4.12__tar.gz → 0.4.20__tar.gz

{winipedia_utils-0.4.12 → winipedia_utils-0.4.20}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: winipedia-utils
-Version: 0.4.12
+Version: 0.4.20
 Summary: A package with many utility functions
 License-Expression: MIT
 License-File: LICENSE
@@ -68,7 +68,7 @@ A comprehensive Python utility package that enforces best practices, automates p
 ```bash
 # 1: Create a new repository on GitHub
 # The default branch must be called main
-# add a PAT or Fine-Grained Access Token to your repo secrets called REPO_TOKEN that has write access to the repository (needed for branch protection in health_check.yaml - see winipedia_utils.git.github.repo.protect)
+# add a PAT or Fine-Grained Access Token to your repo secrets called REPO_TOKEN that has write access to the repository (Adminstration and Contents)(needed for branch protection in health_check.yaml - see winipedia_utils.git.github.repo.protect and for commiting as an action in release.yaml)
 
 # 2: Clone the repository
 git clone https://github.com/owner/repo.git

{winipedia_utils-0.4.12 → winipedia_utils-0.4.20}/README.md

@@ -43,7 +43,7 @@ A comprehensive Python utility package that enforces best practices, automates p
 ```bash
 # 1: Create a new repository on GitHub
 # The default branch must be called main
-# add a PAT or Fine-Grained Access Token to your repo secrets called REPO_TOKEN that has write access to the repository (needed for branch protection in health_check.yaml - see winipedia_utils.git.github.repo.protect)
+# add a PAT or Fine-Grained Access Token to your repo secrets called REPO_TOKEN that has write access to the repository (Adminstration and Contents)(needed for branch protection in health_check.yaml - see winipedia_utils.git.github.repo.protect and for commiting as an action in release.yaml)
 
 # 2: Clone the repository
 git clone https://github.com/owner/repo.git

{winipedia_utils-0.4.12 → winipedia_utils-0.4.20}/pyproject.toml

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

{winipedia_utils-0.4.12 → winipedia_utils-0.4.20}/winipedia_utils/git/github/workflows/base/base.py

@@ -85,11 +85,17 @@ class Workflow(YamlConfigFile):
         return f"{cls.get_workflow_name()}"
 
     @classmethod
-    def get_checkout_step(cls, fetch_depth: int | None = None) -> dict[str, Any]:
+    def get_checkout_step(
+        cls,
+        fetch_depth: int | None = None,
+        *,
+        token: bool = False,
+    ) -> dict[str, Any]:
         """Get the checkout step.
 
         Args:
         fetch_depth: The fetch depth to use. If None, no fetch depth is specified.
+        token: Whether to use the repository token.
 
         Returns:
         The checkout step.
@@ -99,7 +105,10 @@ class Workflow(YamlConfigFile):
             "uses": "actions/checkout@main",
         }
         if fetch_depth is not None:
-            step["with"] = {"fetch-depth": fetch_depth}
+            step.setdefault("with", {})["fetch-depth"] = fetch_depth
+
+        if token:
+            step.setdefault("with", {})["token"] = cls.get_repo_token()
         return step
 
     @classmethod
@@ -110,6 +119,7 @@ class Workflow(YamlConfigFile):
         fetch_depth: int | None = None,
         configure_pipy_token: bool = False,
         force_main_head: bool = False,
+        token: bool = False,
     ) -> list[dict[str, Any]]:
         """Get the poetry steps.
 
@@ -120,11 +130,12 @@ class Workflow(YamlConfigFile):
         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.
+        token: Whether to use the repository token.
 
         Returns:
         The poetry steps.
         """
-        steps = [cls.get_checkout_step(fetch_depth)]
+        steps = [cls.get_checkout_step(fetch_depth, token=token)]
         if force_main_head:
             # exit with code 1 if the running branch is not main
             steps.append(
@@ -133,6 +144,7 @@ class Workflow(YamlConfigFile):
                     "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',  # noqa: E501
                 }
             )
+        steps.append(cls.get_setup_git_step())
         steps.append(
             {
                 "name": "Setup Python",
@@ -162,8 +174,8 @@ class Workflow(YamlConfigFile):
         """Get the release steps."""
         return [
             {
-                "name": "Create and Push Tag",
-                "run": f"git tag {cls.get_version()} && git push origin {cls.get_version()}",  # noqa: E501
+                "name": "Tag and Push",
+                "run": f"git push && git tag {cls.get_version()} && git push origin {cls.get_version()}",  # noqa: E501
             },
             {
                 "name": "Build Changelog",
@@ -212,12 +224,20 @@ class Workflow(YamlConfigFile):
             step["env"] = {"REPO_TOKEN": cls.get_repo_token()}
         return step
 
+    @classmethod
+    def get_setup_git_step(cls) -> dict[str, Any]:
+        """Get the setup git step."""
+        return {
+            "name": "Setup Git",
+            "run": 'git config --global user.email "github-actions[bot]@users.noreply.github.com" && git config --global user.name "github-actions[bot]"',  # noqa: E501
+        }
+
     @classmethod
     def get_commit_step(cls) -> dict[str, Any]:
         """Get the commit step."""
         return {
-            "name": "Commit Changes",
-            "run": "poetry run git commit --no-verify -m 'CI/CD: Committing possible changes to pyproject.toml and poetry.lock' && poetry run git push",  # noqa: E501
+            "name": "Commit added changes",
+            "run": "git commit --no-verify -m '[skip ci] CI/CD: Committing possible added changes (e.g.: pyproject.toml and poetry.lock)'",  # noqa: E501
         }
 
     @classmethod

{winipedia_utils-0.4.12 → winipedia_utils-0.4.20}/winipedia_utils/git/github/workflows/health_check.py

@@ -45,10 +45,12 @@ class HealthCheckWorkflow(Workflow):
                     *(
                         cls.get_poetry_setup_steps(
                             install_dependencies=True,
+                            token=True,
                         )
                     ),
                     cls.get_protect_repository_step(),
                     cls.get_pre_commit_step(),
+                    cls.get_commit_step(),
                     cls.get_extract_version_step(),
                 ],
             ),

{winipedia_utils-0.4.12 → winipedia_utils-0.4.20}/winipedia_utils/git/github/workflows/release.py

@@ -33,9 +33,9 @@ class ReleaseWorkflow(HealthCheckWorkflow):
     @classmethod
     def get_permissions(cls) -> dict[str, Any]:
         """Get the workflow permissions."""
-        return {
-            "contents": "write",
-        }
+        permissions = super().get_permissions()
+        permissions["contents"] = "write"
+        return permissions
 
     @classmethod
     def get_jobs(cls) -> dict[str, Any]: