dycw-actions 0.8.11__py3-none-any.whl → 0.11.3__py3-none-any.whl

actions/__init__.py

@@ -1,3 +1,3 @@
 from __future__ import annotations
 
-__version__ = "0.8.11"
+__version__ = "0.11.3"

actions/clean_dir/lib.py

@@ -4,9 +4,12 @@ from pathlib import Path
 from shutil import rmtree
 from typing import TYPE_CHECKING
 
+from utilities.functions import get_func_name
+from utilities.tabulate import func_param_desc
+
+from actions import __version__
 from actions.clean_dir.settings import SETTINGS
 from actions.logging import LOGGER
-from actions.utilities import log_func_call
 
 if TYPE_CHECKING:
     from collections.abc import Iterator
@@ -16,7 +19,7 @@ if TYPE_CHECKING:
 
 def clean_dir(*, dir_: PathLike = SETTINGS.dir) -> None:
     """Clean a directory."""
-    LOGGER.info(log_func_call(clean_dir, f"{dir_=}"))
+    LOGGER.info(func_param_desc(clean_dir, __version__, f"{dir_=}"))
     dir_ = Path(dir_)
     if not dir_.is_dir():
         msg = f"{str(dir_)!r} is a not a directory"
@@ -31,8 +34,8 @@ def clean_dir(*, dir_: PathLike = SETTINGS.dir) -> None:
             for d in dirs:
                 rmtree(d, ignore_errors=True)
         else:
-            LOGGER.info("Finished cleaning %r", str(dir_))
-            return
+            break
+    LOGGER.info("Finished running %r", get_func_name(clean_dir))
 
 
 def _yield_dirs(*, dir_: PathLike = SETTINGS.dir) -> Iterator[Path]:

actions/cli.py

@@ -4,7 +4,12 @@ from click import group
 from utilities.click import CONTEXT_SETTINGS
 
 from actions.clean_dir.cli import clean_dir_sub_cmd
-from actions.clean_dir.constants import CLEAN_DIR_SUB_CMD
+from actions.clean_dir.constants import CLEAN_DIR_DOCSTRING, CLEAN_DIR_SUB_CMD
+from actions.git_clone_with.cli import git_clone_with_sub_cmd
+from actions.git_clone_with.constants import (
+    GIT_CLONE_WITH_DOCSTRING,
+    GIT_CLONE_WITH_SUB_CMD,
+)
 from actions.pre_commit.conformalize_repo.cli import conformalize_repo_sub_cmd
 from actions.pre_commit.conformalize_repo.constants import (
     CONFORMALIZE_REPO_DOCSTRING,
@@ -54,6 +59,11 @@ from actions.setup_cronjob.constants import (
     SETUP_CRONJOB_DOCSTRING,
     SETUP_CRONJOB_SUB_CMD,
 )
+from actions.setup_ssh_config.cli import setup_ssh_config_sub_cmd
+from actions.setup_ssh_config.constants import (
+    SETUP_SSH_CONFIG_DOCSTRING,
+    SETUP_SSH_CONFIG_SUB_CMD,
+)
 from actions.tag_commit.cli import tag_commit_sub_cmd
 from actions.tag_commit.constants import TAG_COMMIT_DOCSTRING, TAG_COMMIT_SUB_CMD
 
@@ -62,9 +72,12 @@ from actions.tag_commit.constants import TAG_COMMIT_DOCSTRING, TAG_COMMIT_SUB_CM
 def _main() -> None: ...
 
 
-_ = _main.command(name=CLEAN_DIR_SUB_CMD, help=CLEAN_DIR_SUB_CMD, **CONTEXT_SETTINGS)(
+_ = _main.command(name=CLEAN_DIR_SUB_CMD, help=CLEAN_DIR_DOCSTRING, **CONTEXT_SETTINGS)(
     clean_dir_sub_cmd
 )
+_ = _main.command(
+    name=GIT_CLONE_WITH_SUB_CMD, help=GIT_CLONE_WITH_DOCSTRING, **CONTEXT_SETTINGS
+)(git_clone_with_sub_cmd)
 _ = _main.command(
     name=PUBLISH_PACKAGE_SUB_CMD, help=PUBLISH_PACKAGE_DOCSTRING, **CONTEXT_SETTINGS
 )(publish_package_sub_cmd)
@@ -82,6 +95,9 @@ _ = _main.command(
 _ = _main.command(
     name=SETUP_CRONJOB_SUB_CMD, help=SETUP_CRONJOB_DOCSTRING, **CONTEXT_SETTINGS
 )(setup_cronjob_sub_cmd)
+_ = _main.command(
+    name=SETUP_SSH_CONFIG_SUB_CMD, help=SETUP_SSH_CONFIG_DOCSTRING, **CONTEXT_SETTINGS
+)(setup_ssh_config_sub_cmd)
 _ = _main.command(
     name=TAG_COMMIT_SUB_CMD, help=TAG_COMMIT_DOCSTRING, **CONTEXT_SETTINGS
 )(tag_commit_sub_cmd)

actions/constants.py

@@ -20,6 +20,7 @@ PYPROJECT_TOML = Path("pyproject.toml")
 PYRIGHTCONFIG_JSON = Path("pyrightconfig.json")
 PYTEST_TOML = Path("pytest.toml")
 README_MD = Path("README.md")
+SSH = Path.home() / ".ssh"
 RUFF_TOML = Path("ruff.toml")
 
 
@@ -65,5 +66,6 @@ __all__ = [
     "PYTEST_TOML",
     "README_MD",
     "RUFF_TOML",
+    "SSH",
     "YAML_INSTANCE",
 ]

actions/git_clone_with/__init__.py

@@ -0,0 +1 @@
+from __future__ import annotations

actions/git_clone_with/cli.py

@@ -0,0 +1,41 @@
+from __future__ import annotations
+
+from pathlib import Path
+from typing import TYPE_CHECKING
+
+import click
+from click import argument
+from typed_settings import click_options
+from utilities.logging import basic_config
+from utilities.os import is_pytest
+
+from actions.git_clone_with.lib import git_clone_with
+from actions.git_clone_with.settings import Settings
+from actions.logging import LOGGER
+from actions.utilities import LOADER
+
+if TYPE_CHECKING:
+    from utilities.types import PathLike
+
+
+@argument("path_key", type=click.Path(exists=True, dir_okay=False, path_type=Path))
+@argument("owner", type=str)
+@argument("repo", type=str)
+@click_options(Settings, [LOADER], show_envvars_in_help=True)
+def git_clone_with_sub_cmd(
+    settings: Settings, /, *, path_key: PathLike, owner: str, repo: str
+) -> None:
+    if is_pytest():
+        return
+    basic_config(obj=LOGGER)
+    git_clone_with(
+        path_key,
+        owner,
+        repo,
+        path_clone=settings.path_clone,
+        sudo=settings.sudo,
+        branch=settings.branch,
+    )
+
+
+__all__ = ["git_clone_with_sub_cmd"]

actions/git_clone_with/constants.py

@@ -0,0 +1,7 @@
+from __future__ import annotations
+
+GIT_CLONE_WITH_DOCSTRING = "Clone a repository with a deploy key"
+GIT_CLONE_WITH_SUB_CMD = "git-clone-with"
+
+
+__all__ = ["GIT_CLONE_WITH_DOCSTRING", "GIT_CLONE_WITH_SUB_CMD"]

actions/git_clone_with/lib.py

@@ -0,0 +1,78 @@
+from __future__ import annotations
+
+from pathlib import Path
+from typing import TYPE_CHECKING
+
+from utilities.atomicwrites import writer
+from utilities.functions import get_func_name
+from utilities.subprocess import cp, git_clone
+from utilities.tabulate import func_param_desc
+from utilities.text import strip_and_dedent
+
+from actions import __version__
+from actions.constants import SSH
+from actions.git_clone_with.settings import SETTINGS
+from actions.logging import LOGGER
+from actions.setup_ssh_config.lib import get_ssh_config, setup_ssh_config
+
+if TYPE_CHECKING:
+    from utilities.types import PathLike
+
+
+def git_clone_with(
+    path_key: PathLike,
+    owner: str,
+    repo: str,
+    /,
+    *,
+    path_clone: PathLike = SETTINGS.path_clone,
+    sudo: bool = SETTINGS.sudo,
+    branch: str | None = SETTINGS.branch,
+) -> None:
+    LOGGER.info(
+        func_param_desc(
+            git_clone_with,
+            __version__,
+            f"{path_key=}",
+            f"{owner=}",
+            f"{repo=}",
+            f"{path_clone=}",
+            f"{sudo=}",
+            f"{branch=}",
+        )
+    )
+    path_key = Path(path_key)
+    setup_ssh_config()
+    _setup_ssh_config_for_key(path_key)
+    _setup_deploy_key(path_key)
+    git_clone(
+        f"git@{path_key.stem}:{owner}/{repo}", path_clone, sudo=sudo, branch=branch
+    )
+    LOGGER.info("Finished running %r", get_func_name(git_clone_with))
+
+
+def _setup_ssh_config_for_key(path: PathLike, /) -> None:
+    path = Path(path)
+    stem = path.stem
+    path_key = _get_deploy_key(path.name)
+    text = strip_and_dedent(f"""
+        Host {stem}
+            HostName github.com
+            User git
+            IdentityFile {path_key}
+            IdentitiesOnly yes
+    """)
+    with writer(get_ssh_config(stem), overwrite=True) as temp:
+        _ = temp.write_text(text)
+
+
+def _setup_deploy_key(path: PathLike, /) -> None:
+    path = Path(path)
+    cp(path, _get_deploy_key(path.name), perms="u=rw,g=,o=")
+
+
+def _get_deploy_key(name: str, /) -> Path:
+    return SSH / "deploy-keys" / name
+
+
+__all__ = ["git_clone_with"]

actions/git_clone_with/settings.py

@@ -0,0 +1,20 @@
+from __future__ import annotations
+
+from pathlib import Path
+
+from typed_settings import load_settings, option, settings
+
+from actions.utilities import LOADER
+
+
+@settings
+class Settings:
+    path_clone: Path = option(default=Path.cwd(), help="Path to clone to")
+    sudo: bool = option(default=False, help="Run as sudo")
+    branch: str | None = option(default=None, help="Branch to check out")
+
+
+SETTINGS = load_settings(Settings, [LOADER])
+
+
+__all__ = ["SETTINGS", "Settings"]

actions/pre_commit/conformalize_repo/action_dicts.py

@@ -7,7 +7,6 @@ from typed_settings import Secret
 
 from actions.pre_commit.conformalize_repo.settings import SETTINGS
 from actions.publish_package.constants import PUBLISH_PACKAGE_DOCSTRING
-from actions.random_sleep.constants import RANDOM_SLEEP_DOCSTRING
 from actions.run_hooks.constants import RUN_HOOKS_DOCSTRING
 from actions.tag_commit.constants import TAG_COMMIT_DOCSTRING
 
@@ -17,10 +16,11 @@ if TYPE_CHECKING:
 
 def action_publish_package_dict(
     *,
-    token: str | None = SETTINGS.ci__token,
-    username: str | None = SETTINGS.ci__push__publish__username,
-    password: Secret[str] | None = SETTINGS.ci__push__publish__password,
-    publish_url: Secret[str] | None = SETTINGS.ci__push__publish__publish_url,
+    token_checkout: Secret[str] | None = SETTINGS.ci__token_checkout,
+    token_github: Secret[str] | None = SETTINGS.ci__token_github,
+    username: str | None = SETTINGS.ci__push__publish__primary__username,
+    password: Secret[str] | None = SETTINGS.ci__push__publish__primary__password,
+    publish_url: str | None = SETTINGS.ci__push__publish__primary__publish_url,
     trusted_publishing: bool = False,
     native_tls: bool = SETTINGS.uv__native_tls,
 ) -> StrDict:
@@ -29,7 +29,8 @@ def action_publish_package_dict(
         "uses": "dycw/action-publish-package@latest",
     }
     with_: StrDict = {}
-    _add_token(with_, token=token)
+    _add_token_checkout(with_, token=token_checkout)
+    _add_token_github(with_, token=token_github)
     _add_item(with_, "username", value=username)
     _add_item(with_, "password", value=password)
     _add_item(with_, "publish-url", value=publish_url)
@@ -41,7 +42,8 @@ def action_publish_package_dict(
 
 def action_pyright_dict(
     *,
-    token: str | None = SETTINGS.ci__token,
+    token_checkout: Secret[str] | None = SETTINGS.ci__token_checkout,
+    token_github: Secret[str] | None = SETTINGS.ci__token_github,
     python_version: str | None = None,
     resolution: str | None = None,
     prerelease: str | None = None,
@@ -50,7 +52,8 @@ def action_pyright_dict(
 ) -> StrDict:
     out: StrDict = {"name": "Run 'pyright'", "uses": "dycw/action-pyright@latest"}
     with_: StrDict = {}
-    _add_token(with_, token=token)
+    _add_token_checkout(with_, token=token_checkout)
+    _add_token_github(with_, token=token_github)
     _add_python_version(with_, python_version=python_version)
     _add_resolution(with_, resolution=resolution)
     _add_prerelease(with_, prerelease=prerelease)
@@ -62,9 +65,10 @@ def action_pyright_dict(
 
 def action_pytest_dict(
     *,
-    token: str | None = SETTINGS.ci__token,
+    token_checkout: Secret[str] | None = SETTINGS.ci__token_checkout,
+    token_github: Secret[str] | None = SETTINGS.ci__token_github,
     python_version: str | None = None,
-    sops_age_key: str | None = None,
+    sops_age_key: Secret[str] | None = None,
     resolution: str | None = None,
     prerelease: str | None = None,
     native_tls: bool = SETTINGS.uv__native_tls,
@@ -72,7 +76,8 @@ def action_pytest_dict(
 ) -> StrDict:
     out: StrDict = {"name": "Run 'pytest'", "uses": "dycw/action-pytest@latest"}
     with_: StrDict = {}
-    _add_token(with_, token=token)
+    _add_token_checkout(with_, token=token_checkout)
+    _add_token_github(with_, token=token_github)
     _add_python_version(with_, python_version=python_version)
     _add_item(with_, "sops-age-key", value=sops_age_key)
     _add_resolution(with_, resolution=resolution)
@@ -83,39 +88,23 @@ def action_pytest_dict(
     return out
 
 
-def action_random_sleep_dict(
+def action_ruff_dict(
     *,
-    token: str | None = SETTINGS.ci__token,
-    min: int = 0,  # noqa: A002
-    max: int = 3600,  # noqa: A002
-    step: int = 1,
-    log_freq: int = 1,
+    token_checkout: Secret[str] | None = SETTINGS.ci__token_checkout,
+    token_github: Secret[str] | None = SETTINGS.ci__token_github,
 ) -> StrDict:
-    out: StrDict = {
-        "name": RANDOM_SLEEP_DOCSTRING,
-        "uses": "dycw/action-random-sleep@latest",
-    }
-    with_: StrDict = {}
-    _add_token(with_, token=token)
-    with_["min"] = min
-    with_["max"] = max
-    with_["step"] = step
-    with_["log-freq"] = log_freq
-    _add_with_dict(out, with_)
-    return out
-
-
-def action_ruff_dict(*, token: str | None = SETTINGS.ci__token) -> StrDict:
     out: StrDict = {"name": "Run 'ruff'", "uses": "dycw/action-ruff@latest"}
     with_: StrDict = {}
-    _add_token(with_, token=token)
+    _add_token_checkout(with_, token=token_checkout)
+    _add_token_github(with_, token=token_github)
     _add_with_dict(out, with_)
     return out
 
 
 def action_run_hooks_dict(
     *,
-    token: str | None = SETTINGS.ci__token,
+    token_checkout: Secret[str] | None = SETTINGS.ci__token_checkout,
+    token_github: Secret[str] | None = SETTINGS.ci__token_github,
     submodules: str | None = SETTINGS.ci__pull_request__pre_commit__submodules,
     repos: list[str] | None = None,
     hooks: list[str] | None = None,
@@ -129,7 +118,8 @@ def action_run_hooks_dict(
         "uses": "dycw/action-run-hooks@latest",
     }
     with_: StrDict = {}
-    _add_token(with_, token=token)
+    _add_token_checkout(with_, token=token_checkout)
+    _add_token_github(with_, token=token_github)
     _add_item(with_, "submodules", value=submodules)
     _add_yaml_str(with_, "repos", values=repos)
     _add_yaml_str(with_, "hooks", values=hooks)
@@ -142,7 +132,8 @@ def action_run_hooks_dict(
 
 def action_tag_commit_dict(
     *,
-    token: str | None = SETTINGS.ci__token,
+    token_checkout: Secret[str] | None = SETTINGS.ci__token_checkout,
+    token_github: Secret[str] | None = SETTINGS.ci__token_github,
     user_name: str | None = None,
     user_email: str | None = None,
     major_minor: bool = False,
@@ -154,7 +145,8 @@ def action_tag_commit_dict(
         "uses": "dycw/action-tag-commit@latest",
     }
     with_: StrDict = {}
-    _add_token(with_, token=token)
+    _add_token_checkout(with_, token=token_checkout)
+    _add_token_github(with_, token=token_github)
     _add_item(with_, "user-name", value=user_name)
     _add_item(with_, "user-email", value=user_email)
     _add_boolean(with_, "major-minor", value=major_minor)
@@ -209,8 +201,16 @@ def _add_resolution(dict_: StrDict, /, *, resolution: str | None = None) -> None
     _add_item(dict_, "resolution", value=resolution)
 
 
-def _add_token(dict_: StrDict, /, *, token: str | None = SETTINGS.ci__token) -> None:
-    _add_item(dict_, "token", value=token)
+def _add_token_checkout(
+    dict_: StrDict, /, *, token: Secret[str] | None = SETTINGS.ci__token_checkout
+) -> None:
+    _add_item(dict_, "token-checkout", value=token)
+
+
+def _add_token_github(
+    dict_: StrDict, /, *, token: Secret[str] | None = SETTINGS.ci__token_github
+) -> None:
+    _add_item(dict_, "token-github", value=token)
 
 
 def _add_with_dict(dict_: StrDict, with_: StrDict, /) -> None:
@@ -239,7 +239,6 @@ __all__ = [
     "action_publish_package_dict",
     "action_pyright_dict",
     "action_pytest_dict",
-    "action_random_sleep_dict",
     "action_ruff_dict",
     "action_run_hooks_dict",
     "action_tag_commit_dict",

actions/pre_commit/conformalize_repo/cli.py

@@ -16,10 +16,12 @@ def conformalize_repo_sub_cmd(settings: Settings, /) -> None:
         return
     basic_config(obj=LOGGER)
     conformalize_repo(
-        ci__ca_certificates=settings.ci__ca_certificates,
+        ci__certificates=settings.ci__certificates,
         ci__gitea=settings.ci__gitea,
-        ci__token=settings.ci__token,
+        ci__token_checkout=settings.ci__token_checkout,
+        ci__token_github=settings.ci__token_github,
         ci__pull_request__pre_commit=settings.ci__pull_request__pre_commit,
+        ci__pull_request__pre_commit__submodules=settings.ci__pull_request__pre_commit__submodules,
         ci__pull_request__pyright=settings.ci__pull_request__pyright,
         ci__pull_request__pytest__macos=settings.ci__pull_request__pytest__macos,
         ci__pull_request__pytest__ubuntu=settings.ci__pull_request__pytest__ubuntu,
@@ -27,7 +29,17 @@ def conformalize_repo_sub_cmd(settings: Settings, /) -> None:
         ci__pull_request__pytest__all_versions=settings.ci__pull_request__pytest__all_versions,
         ci__pull_request__pytest__sops_age_key=settings.ci__pull_request__pytest__sops_age_key,
         ci__pull_request__ruff=settings.ci__pull_request__ruff,
-        ci__push__publish=settings.ci__push__publish,
+        ci__push__publish__github=settings.ci__push__publish__github,
+        ci__push__publish__primary=settings.ci__push__publish__primary,
+        ci__push__publish__primary__job_name=settings.ci__push__publish__primary__job_name,
+        ci__push__publish__primary__username=settings.ci__push__publish__primary__username,
+        ci__push__publish__primary__password=settings.ci__push__publish__primary__password,
+        ci__push__publish__primary__publish_url=settings.ci__push__publish__primary__publish_url,
+        ci__push__publish__secondary=settings.ci__push__publish__secondary,
+        ci__push__publish__secondary__job_name=settings.ci__push__publish__secondary__job_name,
+        ci__push__publish__secondary__username=settings.ci__push__publish__secondary__username,
+        ci__push__publish__secondary__password=settings.ci__push__publish__secondary__password,
+        ci__push__publish__secondary__publish_url=settings.ci__push__publish__secondary__publish_url,
         ci__push__tag=settings.ci__push__tag,
         ci__push__tag__all=settings.ci__push__tag__all,
         coverage=settings.coverage,

actions/pre_commit/conformalize_repo/constants.py

@@ -1,5 +1,11 @@
 from __future__ import annotations
 
+from pathlib import Path
+from re import search
+
+from utilities.pathlib import GetRootError, get_root
+from utilities.pytest import IS_CI
+
 from actions.pre_commit.constants import PATH_PRE_COMMIT
 
 DOCKERFMT_URL = "https://github.com/reteps/dockerfmt"
@@ -18,6 +24,13 @@ CONFORMALIZE_REPO_SUB_CMD = "conformalize-repo"
 PATH_CONFIGS = PATH_PRE_COMMIT / "conformalize_repo/configs"
 
 
+try:
+    root = get_root()
+except GetRootError:
+    root = Path.cwd()
+RUN_VERSION_BUMP = all(not search("template", p) for p in root.parts) and not IS_CI
+
+
 __all__ = [
     "CONFORMALIZE_REPO_DOCSTRING",
     "CONFORMALIZE_REPO_SUB_CMD",
@@ -25,6 +38,7 @@ __all__ = [
     "PATH_CONFIGS",
     "PRE_COMMIT_HOOKS_URL",
     "RUFF_URL",
+    "RUN_VERSION_BUMP",
     "SHELLCHECK_URL",
     "SHFMT_URL",
     "TAPLO_URL",