vpnhide/scripts/release.py
okhsunrog 0d4cf09866 chore: CI + scripts cleanup (review items #12 #13 #24 #31 #32 #37)
Six small review-list items rolled together — all CI/dev-tooling, no
runtime behaviour change.

  #12  Dockerfile: pin Rust 1.95.0 and cargo-ndk 4.1.2 (was floating
       `stable` + latest cargo-ndk on monthly rebuild). Versions live
       in ENV vars to make the next bump a one-line edit.

  #13  Add shellcheck to lint job. SC2034/SC3043 excluded — Magisk
       reads SKIPUNZIP externally; Android's /system/bin/sh (mksh on
       Pixel) does support `local` despite POSIX. Verified locally
       that the 11 .sh files (module-side + dev tooling) pass.
       shellcheck baked into the CI image via apt; inline apt-get
       fallback covers the window before image rebuild.

  #24  ci.yml keystore.properties: replace heredoc with `printf '%s\n'`.
       Heredoc without single-quoted EOF re-expands $, backticks and
       backslashes in the password — printf takes the value verbatim.

  #31  scripts/release.py::patch_file now hard-fails when a regex
       pattern doesn't match (was silently leaving stale versions).

  #32  Split rotate_fragments_into_history into rotate + delete steps
       so release.py can save_json + write_md *before* unlinking the
       fragment files. If anything in between fails, fragments are
       still on disk and the run is retryable.

  #37  codegen-interfaces.py: emit `assert!(matches_vpn(…), msg)` /
       `assert!(!matches_vpn(…), msg)` instead of
       `assert_eq!(matches_vpn(…), true/false, msg)` —
       clippy::bool_assert_comparison was firing on every generated
       row under `cargo clippy --tests`. Both generated test modules
       regenerated. CI's clippy steps now also pass `--tests` so this
       class of regression is caught.
2026-04-27 01:14:03 +03:00

199 lines
7 KiB
Python
Executable file

#!/usr/bin/env -S uv run --script
#
# /// script
# requires-python = ">=3.12"
# dependencies = [
# "rich",
# ]
# ///
"""Cut a new release: rotate the unreleased changelog into history and
propagate the new version number to every version-bearing source file.
Usage:
release.py X.Y.Z
What it does, atomically:
* `changelog.json`: move `unreleased` -> `history[0]` with
`version=X.Y.Z`, then reset `unreleased` to empty.
* Regenerate `CHANGELOG.md` and `update-json/changelog.md`.
* Write `X.Y.Z` into the `VERSION` file.
* Patch the pinned version in:
- `{kmod,zygisk,portshide}/module/module.prop` (version, versionCode)
- `zygisk/Cargo.toml` (first `version = "..."`)
- `lsposed/native/Cargo.toml` (first `version = "..."`)
- `lsposed/app/build.gradle.kts` (versionName, versionCode)
`versionCode` is derived as `major*10000 + minor*100 + patch`.
After this script succeeds:
1. `git commit -am "chore: release vX.Y.Z"`
2. `git tag vX.Y.Z && git push && git push origin vX.Y.Z`
3. Wait for CI to build and publish the GitHub release.
4. `./scripts/update-json.sh` (post-release step).
"""
from __future__ import annotations
import re
import sys
from pathlib import Path
sys.path.insert(0, str(Path(__file__).resolve().parent))
from changelog_lib import ( # type: ignore[import-not-found]
REPO_ROOT,
delete_fragment_files,
load_fragments,
load_json,
rotate_fragments_into_history,
save_json,
write_md,
)
from rich.console import Console
VERSION_RE = re.compile(r"^\d+\.\d+\.\d+$")
def parse_version(raw: str) -> tuple[str, int]:
if not VERSION_RE.match(raw):
raise SystemExit(f"error: expected MAJOR.MINOR.PATCH, got {raw!r}")
major, minor, patch = (int(p) for p in raw.split("."))
return raw, major * 10000 + minor * 100 + patch
def patch_file(path: Path, replacements: list[tuple[re.Pattern[str], str]]) -> None:
"""Apply each pattern → replacement once.
Hard-fails if any pattern doesn't match. Silently leaving a stale
version in some file because the format drifted from what the regex
expects is exactly the failure mode we want to catch loudly.
"""
text = path.read_text(encoding="utf-8")
new_text = text
for pattern, replacement in replacements:
new_text, n = pattern.subn(replacement, new_text, count=1)
if n == 0:
raise SystemExit(
f"error: pattern {pattern.pattern!r} did not match in {path}. "
f"File format probably changed — update release.py."
)
if new_text != text:
path.write_text(new_text, encoding="utf-8")
def update_module_prop(path: Path, version: str, version_code: int) -> None:
patch_file(
path,
[
(re.compile(r"^version=.*$", re.M), f"version=v{version}"),
(re.compile(r"^versionCode=.*$", re.M), f"versionCode={version_code}"),
],
)
def update_cargo_toml(path: Path, version: str) -> None:
"""Replace the first `version = "..."` line — package version sits at top."""
patch_file(
path,
[(re.compile(r'^version = "[^"]*"$', re.M), f'version = "{version}"')],
)
def update_gradle_kts(path: Path, version: str, version_code: int) -> None:
patch_file(
path,
[
(re.compile(r"versionCode = \d+"), f"versionCode = {version_code}"),
(re.compile(r'versionName = "[^"]*"'), f'versionName = "{version}"'),
],
)
def write_version_file(version: str) -> None:
(REPO_ROOT / "VERSION").write_text(f"{version}\n", encoding="utf-8")
def main() -> int:
console = Console()
if len(sys.argv) != 2:
console.print("[red]usage:[/red] release.py X.Y.Z")
return 2
version, version_code = parse_version(sys.argv[1])
console.print(f"[bold]Releasing v{version}[/bold] [dim](versionCode {version_code})[/dim]")
# Check that the version hasn't already been released.
data = load_json()
for past in data.get("history", []):
if past.get("version") == version:
console.print(
f"[red]error:[/red] v{version} already exists in history[]. Pick a new version.",
)
return 1
fragments = load_fragments()
if not fragments:
console.print(
"[yellow]warning:[/yellow] no changelog fragments under "
"changelog.d/ — releasing an empty changelog.",
)
# Source files must all exist.
files = [
REPO_ROOT / "kmod/module/module.prop",
REPO_ROOT / "zygisk/module/module.prop",
REPO_ROOT / "portshide/module/module.prop",
REPO_ROOT / "zygisk/Cargo.toml",
REPO_ROOT / "lsposed/app/build.gradle.kts",
REPO_ROOT / "lsposed/native/Cargo.toml",
]
for f in files:
if not f.exists():
console.print(f"[red]missing:[/red] {f.relative_to(REPO_ROOT)}")
return 1
# Changelog: rotate fragments into history, persist, then delete the
# fragment files. Order matters — if save_json/write_md fails, the
# fragments are still on disk and the run can be retried safely.
rotate_fragments_into_history(data, fragments, version)
save_json(data)
write_md(data)
delete_fragment_files(fragments)
console.print(
f" [green]✓[/green] changelog: {len(fragments)} fragment(s) → history[0] as v{version}",
)
# VERSION file.
write_version_file(version)
console.print(" [green]✓[/green] VERSION")
# Version-bearing source files.
update_module_prop(REPO_ROOT / "kmod/module/module.prop", version, version_code)
update_module_prop(REPO_ROOT / "zygisk/module/module.prop", version, version_code)
update_module_prop(REPO_ROOT / "portshide/module/module.prop", version, version_code)
update_cargo_toml(REPO_ROOT / "zygisk/Cargo.toml", version)
update_cargo_toml(REPO_ROOT / "lsposed/native/Cargo.toml", version)
update_gradle_kts(REPO_ROOT / "lsposed/app/build.gradle.kts", version, version_code)
console.print(" [green]✓[/green] kmod/module/module.prop")
console.print(" [green]✓[/green] zygisk/module/module.prop")
console.print(" [green]✓[/green] portshide/module/module.prop")
console.print(" [green]✓[/green] zygisk/Cargo.toml")
console.print(" [green]✓[/green] lsposed/native/Cargo.toml")
console.print(" [green]✓[/green] lsposed/app/build.gradle.kts")
console.print()
console.print("[bold]Next steps:[/bold]")
console.print(f' git commit -am "chore: release v{version}"')
console.print(f" git tag v{version} && git push && git push origin v{version}")
console.print(
" # CI builds artifacts and creates a DRAFT release — "
"review on the Releases page, click Publish"
)
console.print(" ./scripts/update-json.sh")
console.print(f' git commit -am "chore: update-json for v{version}"')
console.print(" git push")
return 0
if __name__ == "__main__":
sys.exit(main())