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

actions/__init__.py

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

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

@@ -2,9 +2,13 @@ from __future__ import annotations
 
 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
 
 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__ = ["PATH_ACTIONS", "PATH_CACHE", "PATH_THROTTLE_CACHE", "YAML_INSTANCE"]

actions/pre_commit/conformalize_repo/lib.py

@@ -2,6 +2,7 @@ from __future__ import annotations
 
 import sys
 from contextlib import contextmanager, suppress
+from hashlib import blake2b
 from itertools import product
 from pathlib import Path
 from re import MULTILINE, escape, search, sub
@@ -15,14 +16,12 @@ from ruamel.yaml.scalarstring import LiteralScalarString
 from tomlkit import TOMLDocument, table
 from tomlkit.exceptions import NonExistentKey
 from utilities.inflect import counted_noun
-from utilities.pathlib import get_repo_root
 from utilities.re import extract_groups
 from utilities.subprocess import ripgrep
 from utilities.text import repr_str, strip_and_dedent
+from utilities.throttle import throttle
 from utilities.version import ParseVersionError, Version, parse_version
-from utilities.whenever import HOUR, get_now
-from whenever import ZonedDateTime
-from xdg_base_dirs import xdg_cache_home
+from utilities.whenever import HOUR
 
 from actions import __version__
 from actions.action_dicts.lib import (
@@ -33,7 +32,7 @@ from actions.action_dicts.lib import (
     run_action_ruff_dict,
     run_action_tag_dict,
 )
-from actions.constants import YAML_INSTANCE
+from actions.constants import PATH_THROTTLE_CACHE, YAML_INSTANCE
 from actions.logging import LOGGER
 from actions.pre_commit.conformalize_repo.constants import (
     ACTIONS_URL,
@@ -67,6 +66,7 @@ from actions.pre_commit.replace_sequence_strs.constants import (
 )
 from actions.pre_commit.touch_empty_py.constants import TOUCH_EMPTY_PY_SUB_CMD
 from actions.pre_commit.touch_py_typed.constants import TOUCH_PY_TYPED_SUB_CMD
+from actions.pre_commit.update_requirements.constants import UPDATE_REQUIREMENTS_SUB_CMD
 from actions.pre_commit.utilities import (
     ensure_aot_contains,
     ensure_contains,
@@ -83,7 +83,7 @@ from actions.pre_commit.utilities import (
     yield_toml_doc,
     yield_yaml_dict,
 )
-from actions.utilities import logged_run, write_text
+from actions.utilities import logged_run
 
 if TYPE_CHECKING:
     from collections.abc import Iterator, MutableSet
@@ -284,6 +284,7 @@ def conformalize_repo(
             pytest__ubuntu=github__pull_request__pytest__ubuntu,
             pytest__timeout=pytest__timeout,
             python_version=python_version,
+            repo_name=repo_name,
             ruff=ruff,
             script=script,
         )
@@ -504,6 +505,7 @@ def add_github_pull_request_yaml(
     pytest__windows: bool = SETTINGS.github__pull_request__pytest__windows,
     pytest__timeout: int | None = SETTINGS.pytest__timeout,
     python_version: str = SETTINGS.python_version,
+    repo_name: str | None = SETTINGS.repo_name,
     ruff: bool = SETTINGS.github__pull_request__ruff,
     script: str | None = SETTINGS.script,
 ) -> None:
@@ -516,7 +518,7 @@ def add_github_pull_request_yaml(
         branches = get_list(pull_request, "branches")
         ensure_contains(branches, "master")
         schedule = get_list(on, "schedule")
-        ensure_contains(schedule, {"cron": "0 0 * * *"})
+        ensure_contains(schedule, {"cron": get_cron_job(repo_name=repo_name)})
         jobs = get_dict(dict_, "jobs")
         if pre_commit:
             pre_commit_dict = get_dict(jobs, "pre-commit")
@@ -695,6 +697,7 @@ def add_pre_commit_config_yaml(
             )
             _add_pre_commit_config_repo(dict_, ACTIONS_URL, TOUCH_EMPTY_PY_SUB_CMD)
             _add_pre_commit_config_repo(dict_, ACTIONS_URL, TOUCH_PY_TYPED_SUB_CMD)
+            _add_pre_commit_config_repo(dict_, ACTIONS_URL, UPDATE_REQUIREMENTS_SUB_CMD)
         if ruff:
             _add_pre_commit_config_repo(
                 dict_, RUFF_URL, "ruff-check", args=("add", ["--fix"])
@@ -1050,6 +1053,20 @@ def check_versions() -> None:
 ##
 
 
+def get_cron_job(*, repo_name: str | None = SETTINGS.repo_name) -> str:
+    if repo_name is None:
+        hour = minute = 0
+    else:
+        digest = blake2b(repo_name.encode(), digest_size=8).digest()
+        value = int.from_bytes(digest, "big")
+        minute = value % 60
+        hour = (value // 60) % 24
+    return f"{hour} {minute} * * *"
+
+
+##
+
+
 def get_python_package_name(
     *,
     package_name: str | None = SETTINGS.package_name,
@@ -1123,23 +1140,18 @@ def run_bump_my_version(*, modifications: MutableSet[Path] | None = None) -> Non
 ##
 
 
-def run_pre_commit_update(*, modifications: MutableSet[Path] | None = None) -> None:
-    cache = xdg_cache_home() / "conformalize" / get_repo_root().name
-    try:
-        text = cache.read_text()
-    except FileNotFoundError:
-        ...
-    else:
-        prev = ZonedDateTime.parse_iso(text.rstrip("\n"))
-        if prev >= (get_now() - 12 * HOUR):
-            return
-    write_text(cache, get_now().format_iso())
+def _run_pre_commit_update(*, modifications: MutableSet[Path] | None = None) -> None:
     current = PRE_COMMIT_CONFIG_YAML.read_text()
     logged_run("pre-commit", "autoupdate", print=True)
     if (modifications is not None) and (PRE_COMMIT_CONFIG_YAML.read_text() != current):
         modifications.add(PRE_COMMIT_CONFIG_YAML)
 
 
+run_pre_commit_update = throttle(
+    delta=12 * HOUR, path=PATH_THROTTLE_CACHE / _run_pre_commit_update.__name__
+)(_run_pre_commit_update)
+
+
 ##
 
 
@@ -1278,6 +1290,7 @@ __all__ = [
     "add_readme_md",
     "add_ruff_toml",
     "check_versions",
+    "get_cron_job",
     "get_python_package_name",
     "get_version_from_bumpversion_toml",
     "get_version_from_git_show",

actions/pre_commit/touch_empty_py/lib.py

@@ -5,8 +5,11 @@ from typing import TYPE_CHECKING
 
 from libcst import parse_statement
 from utilities.text import repr_str, strip_and_dedent
+from utilities.throttle import throttle
+from utilities.whenever import HOUR
 
 from actions import __version__
+from actions.constants import PATH_THROTTLE_CACHE
 from actions.logging import LOGGER
 from actions.pre_commit.utilities import yield_python_file
 
@@ -17,7 +20,7 @@ if TYPE_CHECKING:
     from utilities.types import PathLike
 
 
-def touch_empty_py(*paths: PathLike) -> None:
+def _touch_empty_py(*paths: PathLike) -> None:
     LOGGER.info(
         strip_and_dedent("""
             Running '%s' (version %s) with settings:
@@ -38,6 +41,11 @@ def touch_empty_py(*paths: PathLike) -> None:
         sys.exit(1)
 
 
+touch_empty_py = throttle(
+    delta=12 * HOUR, path=PATH_THROTTLE_CACHE / _touch_empty_py.__name__
+)(_touch_empty_py)
+
+
 def _format_path(
     path: PathLike, /, *, modifications: MutableSet[Path] | None = None
 ) -> None:

actions/pre_commit/touch_py_typed/lib.py

@@ -6,8 +6,11 @@ from typing import TYPE_CHECKING
 
 from utilities.iterables import one
 from utilities.text import repr_str, strip_and_dedent
+from utilities.throttle import throttle
+from utilities.whenever import HOUR
 
 from actions import __version__
+from actions.constants import PATH_THROTTLE_CACHE
 from actions.logging import LOGGER
 
 if TYPE_CHECKING:
@@ -16,7 +19,7 @@ if TYPE_CHECKING:
     from utilities.types import PathLike
 
 
-def touch_py_typed(*paths: PathLike) -> None:
+def _touch_py_typed(*paths: PathLike) -> None:
     LOGGER.info(
         strip_and_dedent("""
             Running '%s' (version %s) with settings:
@@ -37,6 +40,11 @@ def touch_py_typed(*paths: PathLike) -> None:
         sys.exit(1)
 
 
+touch_py_typed = throttle(
+    delta=12 * HOUR, path=PATH_THROTTLE_CACHE / _touch_py_typed.__name__
+)(_touch_py_typed)
+
+
 def _format_path(
     path: PathLike, /, *, modifications: MutableSet[Path] | None = None
 ) -> None:

actions/pre_commit/update_requirements/classes.py

@@ -1,8 +1,10 @@
+# ruff: noqa: TC003
 from __future__ import annotations
 
 import re
 from dataclasses import dataclass, field, replace
 from functools import total_ordering
+from pathlib import Path
 from typing import Any, Self, override
 
 from pydantic import BaseModel
@@ -22,6 +24,15 @@ type Version2or3 = Version2 | Version3
 type VersionSet = dict[str, Version2or3]
 
 
+##
+
+
+class PipListOutput(BaseModel):
+    name: str
+    version: str
+    editable_project_location: Path | None = None
+
+
 class PipListOutdatedOutput(BaseModel):
     name: str
     version: str
@@ -29,6 +40,10 @@ class PipListOutdatedOutput(BaseModel):
     latest_filetype: str
 
 
+_ = PipListOutput.model_rebuild()
+_ = PipListOutdatedOutput.model_rebuild()
+
+
 ##
 
 
@@ -100,11 +115,9 @@ def parse_version2(version: str, /) -> Version2:
 _PARSE_VERSION2_PATTERN = re.compile(r"^(\d+)\.(\d+)(?:-(\w+))?")
 
 
-_ = PipListOutdatedOutput.model_rebuild()
-
-
 __all__ = [
     "PipListOutdatedOutput",
+    "PipListOutput",
     "TwoSidedVersions",
     "Version1or2",
     "Version2",

actions/pre_commit/update_requirements/lib.py

@@ -5,12 +5,14 @@ from functools import partial
 from typing import TYPE_CHECKING
 
 from pydantic import TypeAdapter
+from utilities.functions import max_nullable
 from utilities.text import repr_str, strip_and_dedent
 
 from actions import __version__
 from actions.logging import LOGGER
 from actions.pre_commit.update_requirements.classes import (
     PipListOutdatedOutput,
+    PipListOutput,
     Version1or2,
     Version2,
     Version3,
@@ -28,6 +30,7 @@ if TYPE_CHECKING:
     from utilities.types import PathLike
 
     from actions.pre_commit.update_requirements.classes import Version2or3, VersionSet
+    from actions.types import StrDict
 
 
 def update_requirements(*paths: PathLike) -> None:
@@ -66,11 +69,20 @@ def _format_path(
 
 
 def _get_versions() -> VersionSet:
-    json = logged_run(
+    json1 = logged_run(
+        "uv", "pip", "list", "--format", "json", "--strict", return_=True
+    )
+    models1 = TypeAdapter(list[PipListOutput]).validate_json(json1)
+    versions1 = {p.name: parse_version2_or_3(p.version) for p in models1}
+    json2 = logged_run(
         "uv", "pip", "list", "--format", "json", "--outdated", "--strict", return_=True
     )
-    packages = TypeAdapter(list[PipListOutdatedOutput]).validate_json(json)
-    return {p.name: parse_version2_or_3(p.latest_version) for p in packages}
+    models2 = TypeAdapter(list[PipListOutdatedOutput]).validate_json(json2)
+    versions2 = {p.name: parse_version2_or_3(p.latest_version) for p in models2}
+    out: StrDict = {}
+    for key in set(versions1) | set(versions2):
+        out[key] = max_nullable([versions1.get(key), versions2.get(key)])
+    return out
 
 
 def _format_req(requirement: Requirement, /, *, versions: VersionSet) -> Requirement:

actions/register_gitea_runner/__init__.py

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

actions/register_gitea_runner/cli.py

@@ -0,0 +1,32 @@
+from __future__ import annotations
+
+from typed_settings import click_options
+from utilities.logging import basic_config
+from utilities.os import is_pytest
+
+from actions.logging import LOGGER
+from actions.register_gitea_runner.lib import register_gitea_runner
+from actions.register_gitea_runner.settings import Settings
+from actions.utilities import LOADER
+
+
+@click_options(Settings, [LOADER], show_envvars_in_help=True)
+def register_gitea_runner_sub_cmd(settings: Settings, /) -> None:
+    if is_pytest():
+        return
+    basic_config(obj=LOGGER)
+    register_gitea_runner(
+        ssh_user=settings.ssh_user,
+        ssh_host=settings.ssh_host,
+        gitea_container_user=settings.gitea_container_user,
+        gitea_container_name=settings.gitea_container_name,
+        runner_certificate=settings.runner_certificate,
+        runner_capacity=settings.runner_capacity,
+        runner_container_name=settings.runner_container_name,
+        gitea_host=settings.gitea_host,
+        gitea_port=settings.gitea_port,
+        runner_instance_name=settings.runner_instance_name,
+    )
+
+
+__all__ = ["register_gitea_runner_sub_cmd"]

actions/register_gitea_runner/configs/config.yml

@@ -0,0 +1,110 @@
+# Example configuration file, it's safe to copy this as the default config file without any modification.
+
+# You don't have to copy this file to your instance,
+# just run `./act_runner generate-config > config.yaml` to generate a config file.
+
+log:
+  # The level of logging, can be trace, debug, info, warn, error, fatal
+  level: info
+
+runner:
+  # Where to store the registration result.
+  file: .runner
+  # Execute how many tasks concurrently at the same time.
+  capacity: ${CAPACITY}
+  # Extra environment variables to run jobs.
+  envs:
+    A_TEST_ENV_NAME_1: a_test_env_value_1
+    A_TEST_ENV_NAME_2: a_test_env_value_2
+  # Extra environment variables to run jobs from a file.
+  # It will be ignored if it's empty or the file doesn't exist.
+  env_file: .env
+  # The timeout for a job to be finished.
+  # Please note that the Gitea instance also has a timeout (3h by default) for the job.
+  # So the job could be stopped by the Gitea instance if it's timeout is shorter than this.
+  timeout: 3h
+  # The timeout for the runner to wait for running jobs to finish when shutting down.
+  # Any running jobs that haven't finished after this timeout will be cancelled.
+  shutdown_timeout: 0s
+  # Whether skip verifying the TLS certificate of the Gitea instance.
+  insecure: false
+  # The timeout for fetching the job from the Gitea instance.
+  fetch_timeout: 5s
+  # The interval for fetching the job from the Gitea instance.
+  fetch_interval: 2s
+  # The github_mirror of a runner is used to specify the mirror address of the github that pulls the action repository.
+  # It works when something like `uses: actions/checkout@v4` is used and DEFAULT_ACTIONS_URL is set to github,
+  # and github_mirror is not empty. In this case,
+  # it replaces https://github.com with the value here, which is useful for some special network environments.
+  github_mirror: ""
+  # The labels of a runner are used to determine which jobs the runner can run, and how to run them.
+  # Like: "macos-arm64:host" or "ubuntu-latest:docker://docker.gitea.com/runner-images:ubuntu-latest"
+  # Find more images provided by Gitea at https://gitea.com/docker.gitea.com/runner-images .
+  # If it's empty when registering, it will ask for inputting labels.
+  # If it's empty when execute `daemon`, will use labels in `.runner` file.
+  labels:
+    - "ubuntu-latest:docker://docker.gitea.com/runner-images:ubuntu-latest"
+    - "ubuntu-22.04:docker://docker.gitea.com/runner-images:ubuntu-22.04"
+    - "ubuntu-20.04:docker://docker.gitea.com/runner-images:ubuntu-20.04"
+
+cache:
+  # Enable cache server to use actions/cache.
+  enabled: true
+  # The directory to store the cache data.
+  # If it's empty, the cache data will be stored in ${HOME}/.cache/actcache.
+  dir: ""
+  # The host of the cache server.
+  # It's not for the address to listen, but the address to connect from job containers.
+  # So 0.0.0.0 is a bad choice, leave it empty to detect automatically.
+  host: ""
+  # The port of the cache server.
+  # 0 means to use a random available port.
+  port: 0
+  # The external cache server URL. Valid only when enable is true.
+  # If it's specified, act_runner will use this URL as the ACTIONS_CACHE_URL rather than start a server by itself.
+  # The URL should generally end with "/".
+  external_server: ""
+
+container:
+  # Specifies the network to which the container will connect.
+  # Could be host, bridge or the name of a custom network.
+  # If it's empty, act_runner will create a network automatically.
+  network: ""
+  # Whether to use privileged mode or not when launching task containers (privileged mode is required for Docker-in-Docker).
+  privileged: false
+  # And other options to be used when the container is started (eg, --add-host=my.gitea.url:host-gateway).
+  options: "-v ${CERTIFICATE}:/usr/local/share/ca-certificates/root.crt:ro"
+  # The parent directory of a job's working directory.
+  # NOTE: There is no need to add the first '/' of the path as act_runner will add it automatically.
+  # If the path starts with '/', the '/' will be trimmed.
+  # For example, if the parent directory is /path/to/my/dir, workdir_parent should be path/to/my/dir
+  # If it's empty, /workspace will be used.
+  workdir_parent:
+  # Volumes (including bind mounts) can be mounted to containers. Glob syntax is supported, see https://github.com/gobwas/glob
+  # You can specify multiple volumes. If the sequence is empty, no volumes can be mounted.
+  # For example, if you only allow containers to mount the `data` volume and all the json files in `/src`, you should change the config to:
+  # valid_volumes:
+  #   - data
+  #   - /src/*.json
+  # If you want to allow any volume, please use the following configuration:
+  # valid_volumes:
+  #   - '**'
+  valid_volumes: ["**"]
+  # overrides the docker client host with the specified one.
+  # If it's empty, act_runner will find an available docker host automatically.
+  # If it's "-", act_runner will find an available docker host automatically, but the docker host won't be mounted to the job containers and service containers.
+  # If it's not empty or "-", the specified docker host will be used. An error will be returned if it doesn't work.
+  docker_host: ""
+  # Pull docker image(s) even if already present
+  force_pull: true
+  # Rebuild docker image(s) even if already present
+  force_rebuild: false
+  # Always require a reachable docker daemon, even if not required by act_runner
+  require_docker: false
+  # Timeout to wait for the docker daemon to be reachable, if docker is required by require_docker or act_runner
+  docker_timeout: 0s
+
+host:
+  # The parent directory of a job's working directory.
+  # If it's empty, ${HOME}/.cache/act/ will be used.
+  workdir_parent:

actions/register_gitea_runner/configs/entrypoint.sh

@@ -0,0 +1,23 @@
+#!/usr/bin/env sh
+set -euxo
+
+# echo
+echo_date() { echo "[$(date +'%Y-%m-%d %H:%M:%S')] $*" >&2; }
+
+# main
+wait-for-it.sh \
+    --host="${GITEA_HOST}" \
+    --port="${GITEA_PORT}" \
+    --strict \
+    -- \
+    echo "${GITEA_HOST}:${GITEA_PORT} is up"
+
+if ! command -v update-ca-certificates >/dev/null 2>&1; then
+    echo_date "Installing 'ca-certificates'..."
+    apk update
+    apk add --no-cache ca-certificates
+fi
+
+update-ca-certificates || true
+
+exec /sbin/tini -- run.sh

actions/register_gitea_runner/constants.py

@@ -0,0 +1,23 @@
+from __future__ import annotations
+
+import actions.constants
+from actions.constants import PATH_ACTIONS
+
+REGISTER_GITEA_RUNNER_SUB_CMD = "register-gitea-runner"
+REGISTER_GITEA_RUNNER_DOCSTRING = "Register a Gitea runner"
+
+
+PATH_CACHE = actions.constants.PATH_CACHE / REGISTER_GITEA_RUNNER_SUB_CMD
+PATH_CONFIGS = PATH_ACTIONS / "register_gitea_runner/configs"
+PATH_WAIT_FOR_IT = PATH_CACHE / "wait-for-it.sh"
+URL_WAIT_FOR_IT = "https://raw.githubusercontent.com/vishnubob/wait-for-it/refs/heads/master/wait-for-it.sh"
+
+
+__all__ = [
+    "PATH_CACHE",
+    "PATH_CONFIGS",
+    "PATH_WAIT_FOR_IT",
+    "REGISTER_GITEA_RUNNER_DOCSTRING",
+    "REGISTER_GITEA_RUNNER_SUB_CMD",
+    "URL_WAIT_FOR_IT",
+]

actions/register_gitea_runner/lib.py

@@ -0,0 +1,289 @@
+from __future__ import annotations
+
+from pathlib import Path
+from re import search
+from string import Template
+from typing import TYPE_CHECKING
+
+from requests import get
+from utilities.atomicwrites import writer
+from utilities.subprocess import chmod, run, ssh
+from utilities.text import strip_and_dedent
+
+from actions import __version__
+from actions.logging import LOGGER
+from actions.register_gitea_runner.constants import (
+    PATH_CACHE,
+    PATH_CONFIGS,
+    PATH_WAIT_FOR_IT,
+    URL_WAIT_FOR_IT,
+)
+from actions.register_gitea_runner.settings import SETTINGS
+
+if TYPE_CHECKING:
+    from utilities.types import PathLike
+
+
+def register_gitea_runner(
+    *,
+    ssh_user: str = SETTINGS.ssh_user,
+    ssh_host: str = SETTINGS.ssh_host,
+    gitea_container_user: str = SETTINGS.gitea_container_user,
+    gitea_container_name: str = SETTINGS.gitea_container_name,
+    runner_certificate: PathLike = SETTINGS.runner_certificate,
+    runner_capacity: int = SETTINGS.runner_capacity,
+    runner_container_name: str = SETTINGS.runner_container_name,
+    gitea_host: str = SETTINGS.gitea_host,
+    gitea_port: int = SETTINGS.gitea_port,
+    runner_instance_name: str = SETTINGS.runner_instance_name,
+) -> None:
+    """Register against a remote instance of Gitea."""
+    LOGGER.info(
+        strip_and_dedent("""
+            Running '%s' (version %s) with settings:
+             - ssh_user              = %s
+             - ssh_host              = %s
+             - gitea_container_user  = %s
+             - gitea_container_name  = %s
+             - runner_certificate    = %s
+             - runner_capacity       = %d
+             - runner_container_name = %s
+             - gitea_host            = %s
+             - gitea_port            = %d
+             - runner_instance_name  = %s
+        """),
+        register_gitea_runner.__name__,
+        __version__,
+        ssh_user,
+        ssh_host,
+        gitea_container_user,
+        gitea_container_name,
+        runner_certificate,
+        runner_capacity,
+        runner_container_name,
+        gitea_host,
+        gitea_port,
+        runner_instance_name,
+    )
+    token = ssh(
+        ssh_user,
+        ssh_host,
+        *_docker_exec_generate(user=gitea_container_user, name=gitea_container_name),
+        return_=True,
+    )
+    _start_runner(
+        token,
+        runner_certificate=runner_certificate,
+        runner_capacity=runner_capacity,
+        runner_container_name=runner_container_name,
+        gitea_host=gitea_host,
+        gitea_port=gitea_port,
+        runner_instance_name=runner_instance_name,
+    )
+
+
+def register_against_local(
+    *,
+    gitea_container_user: str = SETTINGS.gitea_container_user,
+    gitea_container_name: str = SETTINGS.gitea_container_name,
+    runner_certificate: PathLike = SETTINGS.runner_certificate,
+    runner_capacity: int = SETTINGS.runner_capacity,
+    runner_container_name: str = SETTINGS.runner_container_name,
+    gitea_host: str = SETTINGS.gitea_host,
+    gitea_port: int = SETTINGS.gitea_port,
+    runner_instance_name: str = SETTINGS.runner_instance_name,
+) -> None:
+    """Register against a local instance of Gitea."""
+    LOGGER.info("Registering against %s:%d...", gitea_host, gitea_port)
+    token = run(
+        *_docker_exec_generate(user=gitea_container_user, name=gitea_container_name),
+        return_=True,
+        logger=LOGGER,
+    )
+    _start_runner(
+        token,
+        runner_certificate=runner_certificate,
+        runner_capacity=runner_capacity,
+        runner_container_name=runner_container_name,
+        gitea_host=gitea_host,
+        gitea_port=gitea_port,
+        runner_instance_name=runner_instance_name,
+    )
+
+
+def _check_certificate(*, certificate: PathLike = SETTINGS.runner_certificate) -> None:
+    if not Path(certificate).is_file():
+        msg = f"Missing certificate {certificate!r}"
+        raise FileNotFoundError(msg)
+
+
+def _check_token(text: str, /) -> None:
+    if not search(r"^[A-Za-z0-9]{40}$", text):
+        msg = f"Invalid token; got {text!r}"
+        raise ValueError(msg)
+
+
+def _docker_exec_generate(
+    *,
+    user: str = SETTINGS.gitea_container_user,
+    name: str = SETTINGS.gitea_container_name,
+) -> list[str]:
+    return [
+        "docker",
+        "exec",
+        "--user",
+        user,
+        name,
+        "gitea",
+        "actions",
+        "generate-runner-token",
+    ]
+
+
+def _docker_run_act_runner_args(
+    token: str,
+    /,
+    *,
+    host: str = SETTINGS.gitea_host,
+    port: int = SETTINGS.gitea_port,
+    runner_certificate: PathLike = SETTINGS.runner_certificate,
+    instance_name: str = SETTINGS.runner_instance_name,
+    container_name: str = SETTINGS.runner_container_name,
+) -> list[str]:
+    config_host = _get_config_path(token)
+    config_cont = "/config.yml"
+    entrypoint_host = _get_entrypoint_path(host=host, port=port)
+    entrypoint_cont = Path("/usr/local/bin/entrypoint.sh")
+    return [
+        "docker",
+        "run",
+        "--detach",
+        "--entrypoint",
+        str(entrypoint_cont),
+        "--env",
+        f"CONFIG_FILE={config_cont}",
+        "--env",
+        f"GITEA_INSTANCE_URL=https://{host}:{port}",
+        "--env",
+        f"GITEA_RUNNER_NAME={instance_name}",
+        "--env",
+        f"GITEA_RUNNER_REGISTRATION_TOKEN={token}",
+        "--name",
+        container_name,
+        "--volume",
+        "/var/run/docker.sock:/var/run/docker.sock",
+        "--volume",
+        f"{PATH_WAIT_FOR_IT}:/usr/local/bin/wait-for-it.sh:ro",
+        "--volume",
+        f"{Path.cwd()}/data:/data",
+        "--volume",
+        f"{config_host}:{config_cont}:ro",
+        "--volume",
+        f"{entrypoint_host}:{entrypoint_cont}:ro",
+        "--volume",
+        f"{runner_certificate}:/etc/ssl/certs/runner-certificate.pem:ro",
+        "gitea/act_runner",
+    ]
+
+
+def _docker_stop_runner_args(
+    *, name: str = SETTINGS.runner_container_name
+) -> list[str]:
+    return ["docker", "rm", "--force", name]
+
+
+def _get_config_contents(
+    *,
+    capacity: int = SETTINGS.runner_capacity,
+    certificate: PathLike = SETTINGS.runner_certificate,
+) -> str:
+    src = PATH_CONFIGS / "config.yml"
+    return Template(src.read_text()).safe_substitute(
+        CAPACITY=capacity, CERTIFICATE=certificate
+    )
+
+
+def _get_config_path(token: str, /) -> Path:
+    return PATH_CACHE / f"configs/{token}.yml"
+
+
+def _get_entrypoint_contents(
+    *, host: str = SETTINGS.gitea_host, port: int = SETTINGS.gitea_port
+) -> str:
+    src = PATH_CONFIGS / "entrypoint.sh"
+    return Template(src.read_text()).safe_substitute(GITEA_HOST=host, GITEA_PORT=port)
+
+
+def _get_entrypoint_path(
+    *, host: str = SETTINGS.gitea_host, port: int = SETTINGS.gitea_port
+) -> Path:
+    return PATH_CACHE / f"entrypoints/{host}-{port}"
+
+
+def _start_runner(
+    token: str,
+    /,
+    *,
+    runner_certificate: PathLike = SETTINGS.runner_certificate,
+    runner_capacity: int = SETTINGS.runner_capacity,
+    runner_container_name: str = SETTINGS.runner_container_name,
+    gitea_host: str = SETTINGS.gitea_host,
+    gitea_port: int = SETTINGS.gitea_port,
+    runner_instance_name: str = SETTINGS.runner_instance_name,
+) -> None:
+    _check_certificate(certificate=runner_certificate)
+    _check_token(token)
+    _write_config(token, capacity=runner_capacity, certificate=runner_certificate)
+    _write_entrypoint(host=gitea_host, port=gitea_port)
+    _write_wait_for_it()
+    run(
+        *_docker_stop_runner_args(name=runner_container_name), print=True, logger=LOGGER
+    )
+    run(
+        *_docker_run_act_runner_args(
+            token,
+            host=gitea_host,
+            port=gitea_port,
+            runner_certificate=runner_certificate,
+            instance_name=runner_instance_name,
+            container_name=runner_container_name,
+        ),
+        print=True,
+        logger=LOGGER,
+    )
+
+
+def _write_config(
+    token: str,
+    /,
+    *,
+    capacity: int = SETTINGS.runner_capacity,
+    certificate: PathLike = SETTINGS.runner_certificate,
+) -> None:
+    dest = _get_config_path(token)
+    text = _get_config_contents(capacity=capacity, certificate=certificate)
+    with writer(dest, overwrite=True) as temp:
+        _ = temp.write_text(text)
+
+
+def _write_entrypoint(
+    *, host: str = SETTINGS.gitea_host, port: int = SETTINGS.gitea_port
+) -> None:
+    dest = _get_entrypoint_path(host=host, port=port)
+    text = _get_entrypoint_contents(host=host, port=port)
+    with writer(dest, overwrite=True) as temp:
+        _ = temp.write_text(text)
+        chmod(temp, "u=rwx,g=rx,o=rx")
+
+
+def _write_wait_for_it() -> None:
+    if PATH_WAIT_FOR_IT.is_file():
+        return
+    with writer(PATH_WAIT_FOR_IT, overwrite=True) as temp:
+        resp = get(URL_WAIT_FOR_IT, timeout=60)
+        resp.raise_for_status()
+        _ = temp.write_bytes(resp.content)
+        chmod(temp, "u=rwx,g=rx,o=rx")
+
+
+__all__ = ["register_against_local"]

actions/register_gitea_runner/settings.py

@@ -0,0 +1,33 @@
+from __future__ import annotations
+
+from pathlib import Path
+
+from typed_settings import load_settings, option, settings
+from utilities.getpass import USER
+from utilities.socket import HOSTNAME
+
+from actions.utilities import LOADER
+
+
+@settings
+class Settings:
+    ssh_user: str = option(default="user", help="SSH username")
+    ssh_host: str = option(default="gitea", help="SSH host")
+    gitea_container_user: str = option(default="git", help="Gitea container user name")
+    gitea_container_name: str = option(default="gitea", help="Gitea container name")
+    gitea_host: str = option(default="gitea", help="Gitea host")
+    gitea_port: int = option(default=3000, help="Gitea port")
+    runner_capacity: int = option(default=1, help="Runner capacity")
+    runner_instance_name: str = option(
+        default=f"{USER}--{HOSTNAME}", help="Runner instance name"
+    )
+    runner_certificate: Path = option(
+        default=Path("root.pem"), help="Runner root certificate"
+    )
+    runner_container_name: str = option(default="runner", help="Runner container name")
+
+
+SETTINGS = load_settings(Settings, [LOADER])
+
+
+__all__ = ["SETTINGS", "Settings"]

{dycw_actions-0.7.1.dist-info → dycw_actions-0.7.7.dist-info}/METADATA

@@ -1,16 +1,17 @@
 Metadata-Version: 2.3
 Name: dycw-actions
-Version: 0.7.1
+Version: 0.7.7
 Summary: Library of actions
 Requires-Dist: click>=8.3.1,<9
-Requires-Dist: dycw-utilities>=0.177.0,<1
+Requires-Dist: dycw-utilities>=0.178.0,<1
 Requires-Dist: inflect>=7.5.0,<8
 Requires-Dist: libcst>=1.8.6,<2
 Requires-Dist: packaging>=25.0,<26
 Requires-Dist: pydantic>=2.12.5,<3
 Requires-Dist: pyyaml>=6.0.3,<7
+Requires-Dist: requests>=2.32.5,<3
 Requires-Dist: rich>=14.2.0,<15
-Requires-Dist: ruamel-yaml>=0.19.0,<1
+Requires-Dist: ruamel-yaml>=0.19.1,<1
 Requires-Dist: tomlkit>=0.13.3,<1
 Requires-Dist: typed-settings[attrs,click]>=25.3.0,<26
 Requires-Dist: xdg-base-dirs>=6.0.2,<7

{dycw_actions-0.7.1.dist-info → dycw_actions-0.7.7.dist-info}/RECORD

@@ -1,14 +1,14 @@
-actions/__init__.py,sha256=_OevY0-QRr7A22CyPm0BKMCDflx5qu_IVMMkCcVHxdE,58
+actions/__init__.py,sha256=trsIPKwrk3xNHIWvYXX9uhHoJTOvGbfIIBQNFcFa_Js,58
 actions/action_dicts/__init__.py,sha256=U4S_2y3zgLZVfMenHRaJFBW8yqh2mUBuI291LGQVOJ8,35
 actions/action_dicts/constants.py,sha256=tYYLr3aRRRvnR6NSADOJMN-B6gtqg2A9gBuheEPyGy4,189
 actions/action_dicts/lib.py,sha256=MpK_y5Jao0-3p6bWeYX5QQy3-JjMxwyzXRU5LjO25Iw,5547
 actions/clean_dir/__init__.py,sha256=U4S_2y3zgLZVfMenHRaJFBW8yqh2mUBuI291LGQVOJ8,35
 actions/clean_dir/cli.py,sha256=OrFA2nEN2LyGF22mhTNEBr7KSuKgX54sGy9RyE73qUc,569
 actions/clean_dir/constants.py,sha256=aDNaYtemEv3lcMXo96Oh4pw_HASMby1GZC1D_gbjPAc,167
-actions/clean_dir/lib.py,sha256=s8FdQBd9-PVmPixWFRmpcK6oOHrdutIxtsCSf1N1Tws,1577
+actions/clean_dir/lib.py,sha256=7_-QbvB9Bq2veEl4eYWkBBWN0jSNrjGVlx1gLWS1PwU,1606
 actions/clean_dir/settings.py,sha256=mqM0Oq-yz4dXKcUi3JmOCvDhoeBNQm_Qe70cGmhdcQE,345
-actions/cli.py,sha256=NPiRNWXUyYLcalbDdsQaYDtjdkfSPvR3i6SyVrD5NUQ,4079
-actions/constants.py,sha256=SO0SBwEW8Wn5Uzt95OvlwTctyH0K7uvXMnNf1uCkrxk,212
+actions/cli.py,sha256=J9k7_BQzgDHdgzkTqwXVzncRMHm0eAT0WW_c_gAUFlE,4441
+actions/constants.py,sha256=DgcgYPL3l2lAMIVRi7LzB_YsD0H8WDhaMphh5ztRD54,445
 actions/logging.py,sha256=rMTcQMGndUHTCaXXtyOHt_VXUMhQGRHoN7okpoX0y5I,120
 actions/pre_commit/__init__.py,sha256=U4S_2y3zgLZVfMenHRaJFBW8yqh2mUBuI291LGQVOJ8,35
 actions/pre_commit/click.py,sha256=BLHjkO0gIW7rgLabuWnszwXmI4yb8Li5D8gt81GR-FQ,270
@@ -16,7 +16,7 @@ actions/pre_commit/conformalize_repo/__init__.py,sha256=U4S_2y3zgLZVfMenHRaJFBW8
 actions/pre_commit/conformalize_repo/cli.py,sha256=rPrxobdo4sKnq0de_UWDtrHqlhF6GTAabRhw_1XBeZY,3063
 actions/pre_commit/conformalize_repo/configs/gitignore,sha256=8YCRPwysCD8-67yFXaTg6O8TTl4xeNIh7_DVmaU5Ix0,5063
 actions/pre_commit/conformalize_repo/constants.py,sha256=7WMbc1BwkVPJIf3eh3MaCoWj5A7pSPvNic28nrFTcoA,2148
-actions/pre_commit/conformalize_repo/lib.py,sha256=rgUQjX1ScjQcLeXx9cPqFqGYQmHprUhDodxEjp7RonM,47604
+actions/pre_commit/conformalize_repo/lib.py,sha256=cdEggEXiDTt2QHbzP0rIViFriPoaApf3XcGeAo-hiHY,48020
 actions/pre_commit/conformalize_repo/settings.py,sha256=Oz2AeStS64DFzT1HKJ888_7tiU1TdJIGBarvyKYfp4E,4985
 actions/pre_commit/constants.py,sha256=NBJ5GBMg5qhMAhAfxx1FKw0CdPwW_wG2cUJJ0dkF5HE,158
 actions/pre_commit/format_requirements/__init__.py,sha256=U4S_2y3zgLZVfMenHRaJFBW8yqh2mUBuI291LGQVOJ8,35
@@ -30,16 +30,16 @@ actions/pre_commit/replace_sequence_strs/lib.py,sha256=FzfwYeL3bhTCYbb1T-Yk1NtdH
 actions/pre_commit/touch_empty_py/__init__.py,sha256=U4S_2y3zgLZVfMenHRaJFBW8yqh2mUBuI291LGQVOJ8,35
 actions/pre_commit/touch_empty_py/cli.py,sha256=s2S5OfAGcSLtd2aGm1ooa1k20oNK-LQ1PZWz6T30vO8,559
 actions/pre_commit/touch_empty_py/constants.py,sha256=zSwH60zfn9RhIAbBFnXjHrm2s1nFpPUskX3CZuJpQLk,198
-actions/pre_commit/touch_empty_py/lib.py,sha256=avGiqWRi0x7E4zvvyxaqv_ccRpOT8Le7ol4_ETaXx2s,1458
+actions/pre_commit/touch_empty_py/lib.py,sha256=jxT6CRZ3rrBatk3o-D0xDXon3a-G02sCvdMSNuRvCv0,1706
 actions/pre_commit/touch_py_typed/__init__.py,sha256=U4S_2y3zgLZVfMenHRaJFBW8yqh2mUBuI291LGQVOJ8,35
 actions/pre_commit/touch_py_typed/cli.py,sha256=CDJV4NuUHJlSdJ84dY0XvdwYHMdqygZ7C6x07B-iN3E,559
 actions/pre_commit/touch_py_typed/constants.py,sha256=kLZOm_wgypp7MaXRYq-6AZqVE4OttOMKmUqt11V2zn0,191
-actions/pre_commit/touch_py_typed/lib.py,sha256=Vsi1oDC6nUvWlQdA_a5t-kM5W5o3v0PBZZQe3_QS3Zo,1772
+actions/pre_commit/touch_py_typed/lib.py,sha256=8crPXxI6CwudW13RIJrn3YtrFcZsspyJnTmNRHz4TaU,2020
 actions/pre_commit/update_requirements/__init__.py,sha256=U4S_2y3zgLZVfMenHRaJFBW8yqh2mUBuI291LGQVOJ8,35
-actions/pre_commit/update_requirements/classes.py,sha256=STRC3LS_2PkdvHPgPxkNAcSIDiomzsKhyiP5uhcLUe0,3266
+actions/pre_commit/update_requirements/classes.py,sha256=ERC70c1CxQ3rOsQaEtp6FGbK_VaJ4K0jAV5XTB5-L30,3486
 actions/pre_commit/update_requirements/cli.py,sha256=CBfm8M7hwSRw8KS6ttiNE86IFHJ52V42AxlfakqTDN0,584
 actions/pre_commit/update_requirements/constants.py,sha256=ve44_RYed_41ckgQNPkb08u7Y1cpLpzutGSL9FdGBF8,228
-actions/pre_commit/update_requirements/lib.py,sha256=o3wUfeof-6oLYziHE74Q8WIHk4nyOv5PcK8cFkazm1k,4107
+actions/pre_commit/update_requirements/lib.py,sha256=akSmdqFpDS8ETsdGs4-8lfoKOp_8bBlKyKUXhUlrzpg,4619
 actions/pre_commit/utilities.py,sha256=L1HCi3l778REPfomMuYbxrrnCn0FDRFaWAfmFR0lsTY,11422
 actions/publish_package/__init__.py,sha256=U4S_2y3zgLZVfMenHRaJFBW8yqh2mUBuI291LGQVOJ8,35
 actions/publish_package/cli.py,sha256=nAPHCq67mxUb3yHepVGcoQ69qgaQahM1-cxdbHfxQg0,803
@@ -52,6 +52,13 @@ actions/random_sleep/cli.py,sha256=-d9y63oWgvQtNp9j_8v3zt5gKl-GrUq8-b3Ky52R42c,6
 actions/random_sleep/constants.py,sha256=5GMqCD1f12uyKDVTZBbnDDn6TQa99mUYZb9p-crg5BA,190
 actions/random_sleep/lib.py,sha256=JzgpeEONdKXSBeNc3ex9goVyJR3bsa76lB_tkH1Ggc0,1762
 actions/random_sleep/settings.py,sha256=F8gO2j2EEX8moemwhWWCPdRuOpZ_qLtqzSfWhjIy3P8,529
+actions/register_gitea_runner/__init__.py,sha256=U4S_2y3zgLZVfMenHRaJFBW8yqh2mUBuI291LGQVOJ8,35
+actions/register_gitea_runner/cli.py,sha256=70RUyzKCZHxyDRMFwCAwDC0LDsUZxBi2T6ctzbFlpc8,1129
+actions/register_gitea_runner/configs/config.yml,sha256=0kpaqAjMRDqdSxkSK8ydOk2IsrlkB4cUkYmbkHAurrg,5683
+actions/register_gitea_runner/configs/entrypoint.sh,sha256=IN40hAu8ufyyFWPIgsX_hWp0ZZZ0c36czCaqmECjBrw,476
+actions/register_gitea_runner/constants.py,sha256=wX1f5qvhIXngBVWbIQRoIaXIdPaUByvG8HS8P0WcCGM,694
+actions/register_gitea_runner/lib.py,sha256=V_K6UHmZOD9V-DF6ZNA2QakNyuyuyjgJZ6AJQFf37lQ,8832
+actions/register_gitea_runner/settings.py,sha256=0UQm8M3qDiBE3jiE333M4FdLjikNAzpc9gk_VlzI0s8,1149
 actions/run_hooks/__init__.py,sha256=U4S_2y3zgLZVfMenHRaJFBW8yqh2mUBuI291LGQVOJ8,35
 actions/run_hooks/cli.py,sha256=xKBw6iIlHpUlHl6-QWQLSL6KKVjnsihBeJ7h58Rl8P4,616
 actions/run_hooks/constants.py,sha256=JRhDk08qbzo5C-zwHdXZV5ajvNSKh4GcOcBvOIY6IGU,172
@@ -71,7 +78,7 @@ actions/tag_commit/lib.py,sha256=rq1SqAkNp98cPsNOsFY4F1D6nNi7N3wqVbFPno8lsuI,184
 actions/tag_commit/settings.py,sha256=TOeKG_GODP--2lBSyGzH_M32jDIfh4vk_Ts06R3_ak4,629
 actions/types.py,sha256=GRXLoJtYWmRjgfatDDRMcXKZkN9ZtK1Fi2MEyAZ84uk,591
 actions/utilities.py,sha256=VpFLBiAezgSRlm9dvnyPyQohreaV2Lv7cJ9HAxqZ4WI,4086
-dycw_actions-0.7.1.dist-info/WHEEL,sha256=KSLUh82mDPEPk0Bx0ScXlWL64bc8KmzIPNcpQZFV-6E,79
-dycw_actions-0.7.1.dist-info/entry_points.txt,sha256=2Uu7wAZOm0mmcsGBEsGB370HAWgVWECRFJ9rKgfC3-I,46
-dycw_actions-0.7.1.dist-info/METADATA,sha256=T4208DBQxD3yT09fwfKIiVGyOvSax8tyqNt8MxNGBLM,619
-dycw_actions-0.7.1.dist-info/RECORD,,
+dycw_actions-0.7.7.dist-info/WHEEL,sha256=KSLUh82mDPEPk0Bx0ScXlWL64bc8KmzIPNcpQZFV-6E,79
+dycw_actions-0.7.7.dist-info/entry_points.txt,sha256=2Uu7wAZOm0mmcsGBEsGB370HAWgVWECRFJ9rKgfC3-I,46
+dycw_actions-0.7.7.dist-info/METADATA,sha256=CORF-XquPdSrUKd4Doo9mV0OA8RmDHzyWwZUMXgtC8E,654
+dycw_actions-0.7.7.dist-info/RECORD,,