dycw-actions 0.7.1__py3-none-any.whl → 0.8.4__py3-none-any.whl

actions/__init__.py

@@ -1,3 +1,3 @@
 from __future__ import annotations
 
-__version__ = "0.7.1"
+__version__ = "0.8.4"

actions/clean_dir/lib.py

@@ -17,6 +17,7 @@ if TYPE_CHECKING:
 
 
 def clean_dir(*, dir_: PathLike = SETTINGS.dir) -> None:
+    """Clean a directory."""
     LOGGER.info(
         strip_and_dedent("""
             Running '%s' (version %s) with settings:

actions/cli.py

@@ -42,6 +42,11 @@ from actions.publish_package.constants import (
 )
 from actions.random_sleep.cli import random_sleep_sub_cmd
 from actions.random_sleep.constants import RANDOM_SLEEP_DOCSTRING, RANDOM_SLEEP_SUB_CMD
+from actions.register_gitea_runner.cli import register_gitea_runner_sub_cmd
+from actions.register_gitea_runner.constants import (
+    REGISTER_GITEA_RUNNER_DOCSTRING,
+    REGISTER_GITEA_RUNNER_SUB_CMD,
+)
 from actions.run_hooks.cli import run_hooks_sub_cmd
 from actions.run_hooks.constants import RUN_HOOKS_DOCSTRING, RUN_HOOKS_SUB_CMD
 from actions.setup_cronjob.cli import setup_cronjob_sub_cmd
@@ -69,6 +74,11 @@ _ = _main.command(name=RUN_HOOKS_SUB_CMD, help=RUN_HOOKS_DOCSTRING, **CONTEXT_SE
 _ = _main.command(
     name=RANDOM_SLEEP_SUB_CMD, help=RANDOM_SLEEP_DOCSTRING, **CONTEXT_SETTINGS
 )(random_sleep_sub_cmd)
+_ = _main.command(
+    name=REGISTER_GITEA_RUNNER_SUB_CMD,
+    help=REGISTER_GITEA_RUNNER_DOCSTRING,
+    **CONTEXT_SETTINGS,
+)(register_gitea_runner_sub_cmd)
 _ = _main.command(
     name=SETUP_CRONJOB_SUB_CMD, help=SETUP_CRONJOB_DOCSTRING, **CONTEXT_SETTINGS
 )(setup_cronjob_sub_cmd)

actions/constants.py

@@ -1,10 +1,73 @@
 from __future__ import annotations
 
+from pathlib import Path
+
 from ruamel.yaml import YAML
 from utilities.importlib import files
+from utilities.pathlib import get_repo_root
+from xdg_base_dirs import xdg_cache_home
+
+ACTIONS_URL = "https://github.com/dycw/actions"
+
+
+BUMPVERSION_TOML = Path(".bumpversion.toml")
+COVERAGERC_TOML = Path(".coveragerc.toml")
+ENVRC = Path(".envrc")
+GITEA = Path(".gitea")
+GITHUB = Path(".github")
+GITIGNORE = Path(".gitignore")
+PRE_COMMIT_CONFIG_YAML = Path(".pre-commit-config.yaml")
+PYPROJECT_TOML = Path("pyproject.toml")
+PYRIGHTCONFIG_JSON = Path("pyrightconfig.json")
+PYTEST_TOML = Path("pytest.toml")
+README_MD = Path("README.md")
+REPO_ROOT = get_repo_root()
+RUFF_TOML = Path("ruff.toml")
+
+
+GITHUB_WORKFLOWS, GITEA_WORKFLOWS = [g / "workflows" for g in [GITHUB, GITEA]]
+GITHUB_PULL_REQUEST_YAML, GITEA_PULL_REQUEST_YAML = [
+    w / "pull-request.yaml" for w in [GITHUB_WORKFLOWS, GITEA_WORKFLOWS]
+]
+GITHUB_PUSH_YAML, GITEA_PUSH_YAML = [
+    w / "push.yaml" for w in [GITHUB_WORKFLOWS, GITEA_WORKFLOWS]
+]
+
+
+MAX_PYTHON_VERSION = "3.14"
+
 
 PATH_ACTIONS = files(anchor="actions")
+PATH_CACHE = xdg_cache_home() / "actions"
+PATH_THROTTLE_CACHE = PATH_CACHE / "throttle" / get_repo_root().name
+
+
 YAML_INSTANCE = YAML()
 
 
-__all__ = ["PATH_ACTIONS", "YAML_INSTANCE"]
+__all__ = [
+    "ACTIONS_URL",
+    "BUMPVERSION_TOML",
+    "COVERAGERC_TOML",
+    "ENVRC",
+    "GITEA",
+    "GITEA_PUSH_YAML",
+    "GITEA_WORKFLOWS",
+    "GITHUB",
+    "GITHUB_PULL_REQUEST_YAML",
+    "GITHUB_PUSH_YAML",
+    "GITHUB_WORKFLOWS",
+    "GITHUB_WORKFLOWS",
+    "GITIGNORE",
+    "MAX_PYTHON_VERSION",
+    "PATH_ACTIONS",
+    "PATH_CACHE",
+    "PATH_THROTTLE_CACHE",
+    "PRE_COMMIT_CONFIG_YAML",
+    "PYPROJECT_TOML",
+    "PYRIGHTCONFIG_JSON",
+    "PYTEST_TOML",
+    "README_MD",
+    "RUFF_TOML",
+    "YAML_INSTANCE",
+]

actions/pre_commit/conformalize_repo/action_dicts.py

@@ -0,0 +1,247 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, Any
+
+from ruamel.yaml.scalarstring import LiteralScalarString
+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
+
+if TYPE_CHECKING:
+    from utilities.types import StrDict
+
+
+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,
+    trusted_publishing: bool = False,
+    native_tls: bool = SETTINGS.uv__native_tls,
+) -> StrDict:
+    out: StrDict = {
+        "name": PUBLISH_PACKAGE_DOCSTRING,
+        "uses": "dycw/action-publish-package@latest",
+    }
+    with_: StrDict = {}
+    _add_token(with_, token=token)
+    _add_item(with_, "username", value=username)
+    _add_item(with_, "password", value=password)
+    _add_item(with_, "publish-url", value=publish_url)
+    _add_boolean(with_, "trusted-publishing", value=trusted_publishing)
+    _add_native_tls(with_, native_tls=native_tls)
+    _add_with_dict(out, with_)
+    return out
+
+
+def action_pyright_dict(
+    *,
+    token: str | None = SETTINGS.ci__token,
+    python_version: str | None = None,
+    resolution: str | None = None,
+    prerelease: str | None = None,
+    native_tls: bool = SETTINGS.uv__native_tls,
+    with_requirements: str | None = None,
+) -> StrDict:
+    out: StrDict = {"name": "Run 'pyright'", "uses": "dycw/action-pyright@latest"}
+    with_: StrDict = {}
+    _add_token(with_, token=token)
+    _add_python_version(with_, python_version=python_version)
+    _add_resolution(with_, resolution=resolution)
+    _add_prerelease(with_, prerelease=prerelease)
+    _add_native_tls(with_, native_tls=native_tls)
+    _add_with_requirements(with_, with_requirements=with_requirements)
+    _add_with_dict(out, with_)
+    return out
+
+
+def action_pytest_dict(
+    *,
+    token: str | None = SETTINGS.ci__token,
+    python_version: str | None = None,
+    sops_age_key: str | None = None,
+    resolution: str | None = None,
+    prerelease: str | None = None,
+    native_tls: bool = SETTINGS.uv__native_tls,
+    with_requirements: str | None = None,
+) -> StrDict:
+    out: StrDict = {"name": "Run 'pytest'", "uses": "dycw/action-pytest@latest"}
+    with_: StrDict = {}
+    _add_token(with_, token=token)
+    _add_python_version(with_, python_version=python_version)
+    _add_item(with_, "sops-age-key", value=sops_age_key)
+    _add_resolution(with_, resolution=resolution)
+    _add_prerelease(with_, prerelease=prerelease)
+    _add_native_tls(with_, native_tls=native_tls)
+    _add_with_requirements(with_, with_requirements=with_requirements)
+    _add_with_dict(out, with_)
+    return out
+
+
+def action_random_sleep_dict(
+    *,
+    token: str | None = SETTINGS.ci__token,
+    min: int = 0,  # noqa: A002
+    max: int = 3600,  # noqa: A002
+    step: int = 1,
+    log_freq: int = 1,
+) -> 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_with_dict(out, with_)
+    return out
+
+
+def action_run_hooks_dict(
+    *,
+    token: str | None = SETTINGS.ci__token,
+    submodules: str | None = None,
+    repos: list[str] | None = None,
+    hooks: list[str] | None = None,
+    hooks_exclude: list[str] | None = None,
+    sleep: int | None = None,
+    gitea: bool = SETTINGS.ci__gitea,
+) -> StrDict:
+    out: StrDict = {
+        "if": f"{_runner(gitea=gitea)}.event_name == 'pull_request'",
+        "name": RUN_HOOKS_DOCSTRING,
+        "uses": "dycw/action-run-hooks@latest",
+    }
+    with_: StrDict = {}
+    _add_token(with_, token=token)
+    _add_item(with_, "submodules", value=submodules)
+    _add_yaml_str(with_, "repos", values=repos)
+    _add_yaml_str(with_, "hooks", values=hooks)
+    _add_yaml_str(with_, "hooks-exclude", values=hooks_exclude)
+    _add_item(with_, "hooks", value=hooks)
+    _add_item(with_, "sleep", value=sleep)
+    _add_with_dict(out, with_)
+    return out
+
+
+def action_tag_commit_dict(
+    *,
+    token: str | None = SETTINGS.ci__token,
+    user_name: str | None = None,
+    user_email: str | None = None,
+    major_minor: bool = False,
+    major: bool = False,
+    latest: bool = False,
+) -> StrDict:
+    out: StrDict = {
+        "name": TAG_COMMIT_DOCSTRING,
+        "uses": "dycw/action-tag-commit@latest",
+    }
+    with_: StrDict = {}
+    _add_token(with_, token=token)
+    _add_item(with_, "user-name", value=user_name)
+    _add_item(with_, "user-email", value=user_email)
+    _add_boolean(with_, "major-minor", value=major_minor)
+    _add_boolean(with_, "major", value=major)
+    _add_boolean(with_, "latest", value=latest)
+    _add_with_dict(out, with_)
+    return out
+
+
+def update_ca_certificates_dict(desc: str, /) -> StrDict:
+    return {
+        "name": f"Update CA certificates ({desc})",
+        "run": "sudo update-ca-certificates",
+    }
+
+
+##
+
+
+def _add_boolean(dict_: StrDict, key: str, /, *, value: bool = False) -> None:
+    if value:
+        dict_[key] = value
+
+
+def _add_item(dict_: StrDict, key: str, /, *, value: Any | None = None) -> None:
+    match value:
+        case None:
+            ...
+        case Secret():
+            _add_item(dict_, key, value=value.get_secret_value())
+        case _:
+            dict_[key] = value
+
+
+def _add_native_tls(
+    dict_: StrDict, /, *, native_tls: bool = SETTINGS.uv__native_tls
+) -> None:
+    _add_boolean(dict_, "native-tls", value=native_tls)
+
+
+def _add_python_version(
+    dict_: StrDict, /, *, python_version: str | None = None
+) -> None:
+    _add_item(dict_, "python-version", value=python_version)
+
+
+def _add_prerelease(dict_: StrDict, /, *, prerelease: str | None = None) -> None:
+    _add_item(dict_, "prerelease", value=prerelease)
+
+
+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_with_dict(dict_: StrDict, with_: StrDict, /) -> None:
+    if len(with_) >= 1:
+        dict_["with"] = with_
+
+
+def _add_with_requirements(
+    dict_: StrDict, /, *, with_requirements: str | None = None
+) -> None:
+    _add_item(dict_, "with-requirements", value=with_requirements)
+
+
+def _add_yaml_str(
+    dict_: StrDict, key: str, /, *, values: list[str] | None = None
+) -> None:
+    if values is not None:
+        dict_[key] = LiteralScalarString("\n".join(values))
+
+
+def _runner(*, gitea: bool = False) -> str:
+    return "gitea" if gitea else "github"
+
+
+__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",
+    "update_ca_certificates_dict",
+]

actions/pre_commit/conformalize_repo/cli.py

@@ -16,23 +16,23 @@ def conformalize_repo_sub_cmd(settings: Settings, /) -> None:
         return
     basic_config(obj=LOGGER)
     conformalize_repo(
+        ci__ca_certificates=settings.ci__ca_certificates,
+        ci__gitea=settings.ci__gitea,
+        ci__token=settings.ci__token,
+        ci__pull_request__pre_commit=settings.ci__pull_request__pre_commit,
+        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,
+        ci__pull_request__pytest__windows=settings.ci__pull_request__pytest__windows,
+        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__tag=settings.ci__push__tag,
+        ci__push__tag__all=settings.ci__push__tag__all,
         coverage=settings.coverage,
         description=settings.description,
         envrc=settings.envrc,
         envrc__uv=settings.envrc__uv,
-        envrc__uv__native_tls=settings.envrc__uv__native_tls,
-        github__pull_request__pre_commit=settings.github__pull_request__pre_commit,
-        github__pull_request__pre_commit__gitea=settings.github__pull_request__pre_commit__gitea,
-        github__pull_request__pyright=settings.github__pull_request__pyright,
-        github__pull_request__pytest__macos=settings.github__pull_request__pytest__macos,
-        github__pull_request__pytest__ubuntu=settings.github__pull_request__pytest__ubuntu,
-        github__pull_request__pytest__windows=settings.github__pull_request__pytest__windows,
-        github__pull_request__ruff=settings.github__pull_request__ruff,
-        github__push__publish=settings.github__push__publish,
-        github__push__tag=settings.github__push__tag,
-        github__push__tag__major=settings.github__push__tag__major,
-        github__push__tag__major_minor=settings.github__push__tag__major_minor,
-        github__push__tag__latest=settings.github__push__tag__latest,
         gitignore=settings.gitignore,
         package_name=settings.package_name,
         pre_commit__dockerfmt=settings.pre_commit__dockerfmt,
@@ -42,7 +42,6 @@ def conformalize_repo_sub_cmd(settings: Settings, /) -> None:
         pre_commit__shell=settings.pre_commit__shell,
         pre_commit__taplo=settings.pre_commit__taplo,
         pre_commit__uv=settings.pre_commit__uv,
-        pre_commit__uv__script=settings.pre_commit__uv__script,
         pyproject=settings.pyproject,
         pyproject__project__optional_dependencies__scripts=settings.pyproject__project__optional_dependencies__scripts,
         pyproject__tool__uv__indexes=settings.pyproject__tool__uv__indexes,
@@ -58,6 +57,7 @@ def conformalize_repo_sub_cmd(settings: Settings, /) -> None:
         ruff=settings.ruff,
         run_version_bump=settings.run_version_bump,
         script=settings.script,
+        uv__native_tls=settings.uv__native_tls,
     )
 
 

actions/pre_commit/conformalize_repo/constants.py

@@ -1,14 +1,12 @@
 from __future__ import annotations
 
-from pathlib import Path
 from re import search
 
-from utilities.pathlib import get_repo_root
 from utilities.pytest import IS_CI
 
+from actions.constants import REPO_ROOT
 from actions.pre_commit.constants import PATH_PRE_COMMIT
 
-ACTIONS_URL = "https://github.com/dycw/actions"
 DOCKERFMT_URL = "https://github.com/reteps/dockerfmt"
 PRE_COMMIT_HOOKS_URL = "https://github.com/pre-commit/pre-commit-hooks"
 RUFF_URL = "https://github.com/astral-sh/ruff-pre-commit"
@@ -18,57 +16,23 @@ TAPLO_URL = "https://github.com/compwa/taplo-pre-commit"
 UV_URL = "https://github.com/astral-sh/uv-pre-commit"
 
 
-BUMPVERSION_TOML = Path(".bumpversion.toml")
-COVERAGERC_TOML = Path(".coveragerc.toml")
-ENVRC = Path(".envrc")
-GITIGNORE = Path(".gitignore")
-PRE_COMMIT_CONFIG_YAML = Path(".pre-commit-config.yaml")
-PYPROJECT_TOML = Path("pyproject.toml")
-PYRIGHTCONFIG_JSON = Path("pyrightconfig.json")
-PYTEST_TOML = Path("pytest.toml")
-README_MD = Path("README.md")
-REPO_ROOT = get_repo_root()
-RUFF_TOML = Path("ruff.toml")
-
-
 CONFORMALIZE_REPO_DOCSTRING = "Conformalize a repo"
 CONFORMALIZE_REPO_SUB_CMD = "conformalize-repo"
 
 
-MAX_PYTHON_VERSION = "3.14"
+PATH_CONFIGS = PATH_PRE_COMMIT / "conformalize_repo/configs"
 
 
 RUN_VERSION_BUMP = (search("template", str(REPO_ROOT)) is None) and not IS_CI
 
 
-GITHUB_WORKFLOWS = Path(".github/workflows")
-GITHUB_PULL_REQUEST_YAML = GITHUB_WORKFLOWS / "pull-request.yaml"
-GITHUB_PUSH_YAML = GITHUB_WORKFLOWS / "push.yaml"
-PATH_CONFIGS = PATH_PRE_COMMIT / "conformalize_repo/configs"
-
-
 __all__ = [
-    "ACTIONS_URL",
-    "BUMPVERSION_TOML",
     "CONFORMALIZE_REPO_DOCSTRING",
     "CONFORMALIZE_REPO_SUB_CMD",
-    "COVERAGERC_TOML",
     "DOCKERFMT_URL",
-    "ENVRC",
-    "GITHUB_PULL_REQUEST_YAML",
-    "GITHUB_PUSH_YAML",
-    "GITHUB_WORKFLOWS",
-    "GITIGNORE",
-    "MAX_PYTHON_VERSION",
     "PATH_CONFIGS",
-    "PRE_COMMIT_CONFIG_YAML",
     "PRE_COMMIT_HOOKS_URL",
-    "PYPROJECT_TOML",
-    "PYRIGHTCONFIG_JSON",
-    "PYTEST_TOML",
-    "README_MD",
     "REPO_ROOT",
-    "RUFF_TOML",
     "RUFF_URL",
     "RUN_VERSION_BUMP",
     "SHELLCHECK_URL",