ci-devkit 0.1.0__py3-none-any.whl

ci_devkit/cache.py

@@ -0,0 +1,89 @@
+from __future__ import annotations
+
+import platform
+import shutil
+import sys
+import tempfile
+from pathlib import Path
+from subprocess import CalledProcessError
+
+from bashrun import bash, bash_check, bash_pipe
+
+
+def _posix(path: Path) -> str:
+    return path.as_posix() if platform.system() == "Windows" else str(path)
+
+
+def restore(
+    registry: str,
+    name: str,
+    tag: str,
+    target_directory: Path,
+    *,
+    required: bool = False,
+    fallback_tags: list[str] | None = None,
+) -> bool:
+    # OCI repository names must be lowercase; GitHub repository names preserve case
+    registry = registry.lower()
+    staging = Path(tempfile.gettempdir()) / "cache"
+
+    for candidate_tag in [tag, *(fallback_tags or [])]:
+        if candidate_tag != tag:
+            print(f"Falling back to {name}:{candidate_tag}")
+
+        reference = f"{registry}/{name}:{candidate_tag}"
+        staging.mkdir(parents=True, exist_ok=True)
+
+        if not bash_check(f"oras pull {reference} -o {staging}"):
+            shutil.rmtree(staging, ignore_errors=True)
+            continue
+
+        archive = staging / f"{name}.tar.zst"
+        try:
+            if platform.system() == "Windows":
+                bash_pipe(f"zstd -d {_posix(archive)} --stdout", f"tar -xf - -C {_posix(target_directory)}")
+            else:
+                bash(f"tar -xf {archive} -C {target_directory}")
+        except CalledProcessError:
+            print(f"WARNING: Cache extraction failed for {name}:{candidate_tag}, trying next")
+            shutil.rmtree(staging, ignore_errors=True)
+            continue
+
+        shutil.rmtree(staging, ignore_errors=True)
+        print(f"Cache hit: {name}:{candidate_tag}")
+        return True
+
+    if required:
+        print(f"FATAL: Required cache missing: {registry}/{name}:{tag}")
+        sys.exit(1)
+
+    print(f"Cache miss: {name}")
+    return False
+
+
+def save(registry: str, name: str, tag: str, source_directory: Path, paths: list[str]) -> None:
+    # OCI repository names must be lowercase; GitHub repository names preserve case
+    registry = registry.lower()
+    resolved: list[str] = []
+    for pattern in paths:
+        if any(character in pattern for character in "*?["):
+            matches = sorted(source_directory.glob(pattern))
+            resolved.extend(str(match.relative_to(source_directory)) for match in matches)
+        else:
+            resolved.append(pattern)
+
+    staging = Path(tempfile.gettempdir()) / "cache"
+    staging.mkdir(parents=True, exist_ok=True)
+    archive_name = f"{name}.tar.zst"
+    archive_path = staging / archive_name
+
+    joined = " ".join(resolved)
+    if platform.system() == "Windows":
+        bash_pipe(f"tar -cf - {joined}", f"zstd -o {_posix(archive_path)}", cwd=source_directory)
+    else:
+        bash(f"tar --zstd -cf {archive_path} {joined}", cwd=source_directory)
+
+    reference = f"{registry}/{name}:{tag}"
+    bash(f"oras push {reference} {archive_name}:application/vnd.ci-devkit.cache.v1+zstd", cwd=staging)
+    archive_path.unlink()
+    print(f"Saved cache: {reference}")

ci_devkit/ci_step.py

@@ -0,0 +1,52 @@
+from __future__ import annotations
+
+import time
+from collections.abc import Generator
+from contextlib import contextmanager
+
+from pydantic_settings import BaseSettings
+
+
+class Settings(BaseSettings):
+    github_step_summary: str | None = None
+
+
+settings = Settings.model_validate({})
+_summary_initialized = False
+
+
+def _format_duration(seconds: float) -> str:
+    if seconds < 60:
+        return f"{seconds:.1f}s"
+    minutes = int(seconds // 60)
+    remaining = seconds % 60
+    return f"{minutes}m {remaining:.0f}s"
+
+
+def _write_summary(label: str, duration: float, *, failed: bool) -> None:
+    global _summary_initialized
+    summary_path = settings.github_step_summary
+    if not summary_path:
+        return
+    with open(summary_path, "a") as file:
+        if not _summary_initialized:
+            file.write("| Step | Duration |\n|---|---|\n")
+            _summary_initialized = True
+        status = " :x:" if failed else ""
+        file.write(f"| {label}{status} | {_format_duration(duration)} |\n")
+
+
+@contextmanager
+def ci_step(label: str) -> Generator[None]:
+    print(f"::group::{label}", flush=True)
+    start = time.monotonic()
+    failed = False
+    try:
+        yield
+    except BaseException:
+        failed = True
+        raise
+    finally:
+        duration = time.monotonic() - start
+        print("::endgroup::", flush=True)
+        _write_summary(label, duration, failed=failed)

ci_devkit/git_tags.py

@@ -0,0 +1,28 @@
+from __future__ import annotations
+
+from pathlib import Path
+
+from bashrun import bash, bash_check, bash_output
+
+
+def list_tag_versions(prefix: str) -> list[str]:
+    output = bash_output(f'git tag --list "{prefix}*" --sort=-v:refname').strip()
+    if not output:
+        return []
+    return [tag[len(prefix) :] for tag in output.splitlines()]
+
+
+def get_latest_tag_version(prefix: str) -> str | None:
+    versions = list_tag_versions(prefix)
+    return versions[0] if versions else None
+
+
+def has_changes_since_tag(tag: str | None, path: Path) -> bool:
+    if tag is None:
+        return True
+    return not bash_check(f"git diff --quiet {tag} HEAD -- {path}")
+
+
+def create_and_push_tag(tag: str) -> None:
+    bash(f"git tag {tag}")
+    bash(f"git push origin {tag}")

ci_devkit/setup.py

@@ -0,0 +1,127 @@
+from __future__ import annotations
+
+import os
+import platform
+import re
+import shlex
+import shutil
+from pathlib import Path
+
+from bashrun import bash, bash_no_raise, bash_output
+from pydantic import Field
+from pydantic_settings import BaseSettings
+
+
+class Settings(BaseSettings):
+    github_path: str | None = None
+    system_drive: str = Field("C:", validation_alias="SystemDrive")
+    agent_tools_directory: str | None = Field(None, validation_alias="AGENT_TOOLSDIRECTORY")
+
+
+settings = Settings.model_validate({})
+
+CONTAINER_PATHS = ["/to_clean/android", "/to_clean/dotnet", "/to_clean/ghcup", "/to_clean/swift"]
+
+BARE_LINUX_PATHS = ["/usr/local/lib/android", "/usr/share/dotnet", "/usr/local/.ghcup", "/usr/share/swift", "/opt/ghc"]
+
+LARGE_PACKAGE_PATTERNS = [
+    "^aspnetcore-.*",
+    "^dotnet-.*",
+    "^llvm-.*",
+    "php.*",
+    "^mongodb-.*",
+    "^mysql-.*",
+    "azure-cli",
+    "google-chrome-stable",
+    "firefox",
+    "powershell",
+    "mono-devel",
+    "libgl1-mesa-dri",
+    "google-cloud-sdk",
+    "google-cloud-cli",
+]
+
+
+def _remove_paths(paths: list[str], sudo: bool = False) -> None:
+    existing = [path for path in paths if Path(path).exists()]
+    if not existing:
+        return
+    if sudo:
+        bash_no_raise(f"sudo rm -rf {shlex.join(existing)}")
+    elif platform.system() == "Windows":
+        for path in existing:
+            shutil.rmtree(path, ignore_errors=True)
+    else:
+        bash_no_raise(f"rm -rf {shlex.join(existing)}")
+
+
+# actions/checkout sets safe.directory in a temporary HOME that's cleaned up
+# after the step finishes (actions/checkout#766). Container jobs that run
+# git later need it re-set in the real HOME.
+def configure_git(workspace: str) -> None:
+    bash(f"git config --global --add safe.directory {shlex.quote(workspace)}")
+
+
+def free_disk_space(*, large_packages: bool = False, docker_images: bool = False, swap_storage: bool = False) -> None:
+    system = platform.system()
+    in_container = Path("/to_clean").is_dir()
+
+    if system == "Windows":
+        paths = [os.path.join(settings.system_drive, "Program Files", "dotnet")]
+        if settings.agent_tools_directory:
+            paths.append(settings.agent_tools_directory)
+        print(f"Removing: {', '.join(paths)}")
+        _remove_paths(paths)
+    elif in_container:
+        print("Removing pre-installed toolchains (container)")
+        _remove_paths(CONTAINER_PATHS)
+    else:
+        print("Removing pre-installed toolchains")
+        _remove_paths(BARE_LINUX_PATHS, sudo=True)
+
+        if large_packages:
+            print("Removing large apt packages")
+            bash_no_raise(f"sudo apt-get remove -y --fix-missing {shlex.join(LARGE_PACKAGE_PATTERNS)}")
+            bash_no_raise("sudo apt-get autoremove -y")
+            bash_no_raise("sudo apt-get clean")
+
+        if docker_images:
+            print("Pruning Docker images")
+            bash_no_raise("sudo docker image prune --all --force")
+
+        if swap_storage:
+            print("Removing swap")
+            bash_no_raise("sudo swapoff -a")
+            bash_no_raise("sudo rm -f /mnt/swapfile")
+
+    bash("df -h")
+
+
+def install_dotnet(channel: str) -> None:
+    print(f"Installing .NET SDK {channel}")
+    script = Path(__file__).parent / "third-party" / "dotnet-install.sh"
+    bash(f"bash {script} --channel {channel}")
+    dotnet_path = str(Path.home() / ".dotnet")
+    os.environ["PATH"] = f"{dotnet_path}{os.pathsep}{os.environ['PATH']}"
+    if settings.github_path:
+        with open(settings.github_path, "a") as file:
+            file.write(f"{dotnet_path}\n")
+
+
+def install_node(version: str, registry_url: str | None = None) -> None:
+    system = platform.system()
+    sudo = system == "Linux" and os.geteuid() != 0
+
+    print(f"Installing Node.js {version}")
+    shasums = bash_output(f"curl -fsSL https://nodejs.org/dist/latest-v{version}.x/SHASUMS256.txt")
+    match = re.search(r"(node-v[\d.]+-linux-x64\.tar\.xz)", shasums)
+    if not match:
+        raise SystemExit(f"Could not find Node.js v{version} linux-x64 binary")
+    filename = match.group(1)
+    prefix = "sudo " if sudo else ""
+    bash(f"curl -fsSLO https://nodejs.org/dist/latest-v{version}.x/{filename}")
+    bash(f"{prefix}rm -rf /usr/local/lib/node_modules/npm")
+    bash(f"{prefix}tar -xJf {filename} -C /usr/local --strip-components=1")
+    Path(filename).unlink()
+    if registry_url:
+        (Path.home() / ".npmrc").write_text(f"registry={registry_url}\n")

ci_devkit/setup_oras.py

@@ -0,0 +1,51 @@
+from __future__ import annotations
+
+import os
+import platform
+import shlex
+import shutil
+from pathlib import Path
+
+from bashrun import bash
+from pydantic_settings import BaseSettings
+
+
+class Settings(BaseSettings):
+    github_token: str
+    github_actor: str = ""
+    github_path: str | None = None
+    runner_temp: str = "."
+
+
+def install_oras(version: str = "1.2.2") -> None:
+    settings = Settings.model_validate({})
+    system = platform.system()
+    sudo = system == "Linux" and os.geteuid() != 0
+    prefix = "sudo " if sudo else ""
+
+    if system == "Linux":
+        bash(f"{prefix}apt-get update -qq")
+        bash(f"{prefix}apt-get install -y -qq zstd")
+    elif system == "Windows":
+        bash("choco install zstandard -y --no-progress")
+
+    if system == "Linux":
+        archive = f"oras_{version}_linux_amd64.tar.gz"
+        bash(f"curl -fsSLO https://github.com/oras-project/oras/releases/download/v{version}/{archive}")
+        bash(f"{prefix}tar -xzf {archive} -C /usr/local/bin/ oras")
+        Path(archive).unlink()
+    elif system == "Windows":
+        archive = f"oras_{version}_windows_amd64.zip"
+        oras_directory = Path(settings.runner_temp) / "oras"
+        bash(f"curl -fsSLO https://github.com/oras-project/oras/releases/download/v{version}/{archive}")
+        shutil.unpack_archive(archive, oras_directory)
+        Path(archive).unlink()
+        os.environ["PATH"] = f"{oras_directory}{os.pathsep}{os.environ['PATH']}"
+        if settings.github_path:
+            with open(settings.github_path, "a") as file:
+                file.write(f"{oras_directory}\n")
+
+    bash(
+        f"oras login ghcr.io --username {shlex.quote(settings.github_actor)} --password-stdin",
+        stdin_text=settings.github_token,
+    )

ci_devkit/third-party/README.md

@@ -0,0 +1,9 @@
+# Third-party vendored files
+
+## dotnet-install.sh
+
+- **Source**: https://dot.net/v1/dotnet-install.sh
+- **Upstream repo**: https://github.com/dotnet/install-scripts
+- **License**: MIT (see header in script)
+- **Vendored**: 2026-03-16
+- **Why**: The `actions/setup-dotnet` GitHub Action bundles this script locally to avoid downloading it at runtime. We vendor it for the same reason — downloading it via curl inside CI containers is unreliable (timeouts).