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

actions/pre_commit/conformalize_repo/settings.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from typed_settings import load_settings, option, settings
+from typed_settings import Secret, load_settings, option, secret, settings
 
 from actions.pre_commit.conformalize_repo.constants import RUN_VERSION_BUMP
 from actions.utilities import LOADER
@@ -8,47 +8,53 @@ from actions.utilities import LOADER
 
 @settings
 class Settings:
-    coverage: bool = option(default=False, help="Set up '.coveragerc.toml'")
-    description: str | None = option(default=None, help="Repo description")
-    envrc: bool = option(default=False, help="Set up '.envrc'")
-    envrc__uv: bool = option(default=False, help="Set up '.envrc' with uv")
-    envrc__uv__native_tls: bool = option(
-        default=False, help="Set up '.envrc' with uv native TLS"
+    ci__ca_certificates: bool = option(
+        default=False, help="Update CA certficates before each step"
+    )
+    ci__gitea: bool = option(default=False, help="Set up CI on Gitea")
+    ci__token: str | None = option(default=None, help="Set up CI with this token")
+    ci__pull_request__pre_commit: bool = option(
+        default=False, help="Set up CI 'pull-request.yaml' pre-commit"
     )
-    github__pull_request__pre_commit: bool = option(
-        default=False, help="Set up 'pull-request.yaml' pre-commit"
+    ci__pull_request__pyright: bool = option(
+        default=False, help="Set up CI 'pull-request.yaml' pyright"
     )
-    github__pull_request__pre_commit__gitea: bool = option(
-        default=False, help="Set up 'pull-request.yaml' for Gitea"
+    ci__pull_request__pytest__macos: bool = option(
+        default=False, help="Set up CI 'pull-request.yaml' pytest with MacOS"
     )
-    github__pull_request__pyright: bool = option(
-        default=False, help="Set up 'pull-request.yaml' pyright"
+    ci__pull_request__pytest__ubuntu: bool = option(
+        default=False, help="Set up CI 'pull-request.yaml' pytest with Ubuntu"
     )
-    github__pull_request__pytest__macos: bool = option(
-        default=False, help="Set up 'pull-request.yaml' pytest with MacOS"
+    ci__pull_request__pytest__windows: bool = option(
+        default=False, help="Set up CI 'pull-request.yaml' pytest with Windows"
     )
-    github__pull_request__pytest__ubuntu: bool = option(
-        default=False, help="Set up 'pull-request.yaml' pytest with Ubuntu"
+    ci__pull_request__pytest__sops_age_key: str | None = option(
+        default=None,
+        help="Set up CI 'pull-request.yaml' pytest with this 'age' key for 'sops'",
     )
-    github__pull_request__pytest__windows: bool = option(
-        default=False, help="Set up 'pull-request.yaml' pytest with Windows"
+    ci__pull_request__ruff: bool = option(
+        default=False, help="Set up CI 'pull-request.yaml' ruff"
     )
-    github__pull_request__ruff: bool = option(
-        default=False, help="Set up 'pull-request.yaml' ruff"
+    ci__push__publish: bool = option(
+        default=False, help="Set up CI 'push.yaml' publishing"
     )
-    github__push__publish: bool = option(
-        default=False, help="Set up 'push.yaml' publishing"
+    ci__push__publish__username: str | None = option(
+        default=None, help="Set up CI 'push.yaml' publishing with this username"
     )
-    github__push__tag: bool = option(default=False, help="Set up 'push.yaml' tagging")
-    github__push__tag__major: bool = option(
-        default=False, help="Set up 'push.yaml' with the 'major' tag"
+    ci__push__publish__password: Secret[str] | None = secret(
+        default=None, help="Set up CI 'push.yaml' publishing with this password"
     )
-    github__push__tag__major_minor: bool = option(
-        default=False, help="Set up 'push.yaml' with the 'major.minor' tag"
+    ci__push__publish__publish_url: Secret[str] | None = secret(
+        default=None, help="Set up CI 'push.yaml' publishing with this URL"
     )
-    github__push__tag__latest: bool = option(
-        default=False, help="Set up 'push.yaml' tagging"
+    ci__push__tag: bool = option(default=False, help="Set up CI 'push.yaml' tagging")
+    ci__push__tag__all: bool = option(
+        default=False, help="Set up CI 'push.yaml' tagging with all tags"
     )
+    coverage: bool = option(default=False, help="Set up '.coveragerc.toml'")
+    description: str | None = option(default=None, help="Repo description")
+    envrc: bool = option(default=False, help="Set up '.envrc'")
+    envrc__uv: bool = option(default=False, help="Set up '.envrc' with uv")
     gitignore: bool = option(default=False, help="Set up '.gitignore'")
     package_name: str | None = option(default=None, help="Package name")
     pre_commit__dockerfmt: bool = option(
@@ -72,9 +78,6 @@ class Settings:
     pre_commit__uv: bool = option(
         default=False, help="Set up '.pre-commit-config.yaml' uv"
     )
-    pre_commit__uv__script: str | None = option(
-        default=None, help="Set up '.pre-commit-config.yaml' uv lock script"
-    )
     pyproject: bool = option(default=False, help="Set up 'pyproject.toml'")
     pyproject__project__optional_dependencies__scripts: bool = option(
         default=False,
@@ -100,6 +103,7 @@ class Settings:
     repo_name: str | None = option(default=None, help="Repo name")
     ruff: bool = option(default=False, help="Set up 'ruff.toml'")
     run_version_bump: bool = option(default=RUN_VERSION_BUMP, help="Run version bump")
+    uv__native_tls: bool = option(default=False, help="Setup 'uv' with native TLS")
     script: str | None = option(
         default=None, help="Set up a script instead of a package"
     )

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,
@@ -25,7 +27,7 @@ if TYPE_CHECKING:
     from pathlib import Path
 
     from utilities.packaging import Requirement
-    from utilities.types import PathLike
+    from utilities.types import PathLike, StrDict
 
     from actions.pre_commit.update_requirements.classes import Version2or3, VersionSet
 
@@ -66,11 +68,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/pre_commit/utilities.py

@@ -15,19 +15,18 @@ from tomlkit.items import AoT, Array, Table
 from utilities.functions import ensure_class, ensure_str
 from utilities.iterables import OneEmptyError, OneNonUniqueError, one
 from utilities.packaging import Requirement
-from utilities.types import PathLike
+from utilities.types import PathLike, StrDict
 
 from actions.constants import YAML_INSTANCE
 from actions.logging import LOGGER
-from actions.types import StrDict
 from actions.utilities import are_equal_modulo_new_line, write_text, yaml_dump
 
 if TYPE_CHECKING:
     from collections.abc import Callable, Iterable, Iterator, MutableSet
 
-    from utilities.types import PathLike
+    from utilities.types import PathLike, StrDict
 
-    from actions.types import FuncRequirement, HasAppend, HasSetDefault, StrDict
+    from actions.types import FuncRequirement, HasAppend, HasSetDefault
 
 
 def ensure_aot_contains(array: AoT, /, *tables: Table) -> None:

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",
+]