#!/usr/bin/env python3 import os import sys import subprocess import datetime from pathlib import Path import time import json import textwrap # REPO ROOT relative to script dir ROOT = Path(__file__).resolve().parents[2] SCRIPTS = ROOT / 'scripts/ci' # ---------------------------------------------------------- # helpers # ---------------------------------------------------------- def run(cmd, check=True, cwd=None): wd = cwd if cwd is not None else ROOT print(f"$ {cmd}", flush=True, file=sys.stderr) subprocess.run( cmd, shell=True, cwd=wd, check=check, stdout=sys.stderr, stderr=sys.stderr, ) print("", flush=True, file=sys.stderr) def runAndGet(cmd, cwd=None): wd = cwd if cwd is not None else ROOT print(f"$ {cmd}", flush=True, file=sys.stderr) result = subprocess.run( cmd, shell=True, cwd=wd, stdout=subprocess.PIPE, stderr=sys.stderr, text=True, check=True, ) out = result.stdout.strip() print(out, flush=True, file=sys.stderr) print("", flush=True, file=sys.stderr) return out def getenv(name, default=""): return os.environ.get(name, default) # ---------------------------------------------------------- # SHARED # ---------------------------------------------------------- def short_commit(): return runAndGet("git rev-parse --short HEAD") # ---------------------------------------------------------- # BUILD NUMBER RESERVATION # ---------------------------------------------------------- def reserve_build_number(repo, max_attempts=5): repo = Path(repo).resolve() version_json = repo / "version.json" def utc_now(): return datetime.datetime.now(datetime.UTC).strftime("%Y-%m-%dT%H:%M:%SZ") def read(): branch = runAndGet("git rev-parse --abbrev-ref HEAD", cwd=repo) defaults = { "build": 0, "issued_at": utc_now(), "tag": branch, } if version_json.exists(): data = json.loads(version_json.read_text()) else: data = {} # fill missing fields for k, v in defaults.items(): data.setdefault(k, v) # ensure tag always tracks current branch data["tag"] = branch version_json.write_text(json.dumps(data, indent=2) + "\n") return data def write(data): version_json.write_text(json.dumps(data, indent=2) + "\n") for attempt in range(max_attempts): run("git fetch --depth=1 origin HEAD", check=False, cwd=repo) run("git reset --hard FETCH_HEAD", check=False, cwd=repo) data = read() data["build"] += 1 data["issued_at"] = utc_now() write(data) run("git add version.json", check=False, cwd=repo) run(f"git commit -m '{data['tag']} - build no: {data['build']}' || true", check=False, cwd=repo) rc = subprocess.call("git push", shell=True, cwd=repo) if rc == 0: print(f"Reserved build #{data['build']}", file=sys.stderr) return data["build"] print("Push rejected, retrying...", file=sys.stderr) time.sleep(2) raise SystemExit("Failed reserving build number") # ---------------------------------------------------------- # PROJECT INFO # ---------------------------------------------------------- def get_product_name(): return runAndGet( "xcodebuild -showBuildSettings " "| grep PRODUCT_NAME " "| tail -1 " "| sed -e 's/.*= //g'" ) def get_bundle_id(): return runAndGet( "xcodebuild -showBuildSettings 2>&1 " "| grep 'PRODUCT_BUNDLE_IDENTIFIER = ' " "| tail -1 " "| sed -e 's/.*= //g'" ) def get_marketing_version(): return runAndGet("grep MARKETING_VERSION Build.xcconfig | sed -e 's/MARKETING_VERSION = //g'") def set_marketing_version(qualified): run( f"sed -E " f"'s/^MARKETING_VERSION = .*/MARKETING_VERSION = {qualified}/' " f"-i '' {ROOT}/Build.xcconfig" ) def compute_qualified_version(marketing, build_num, channel, short): date = datetime.datetime.now(datetime.UTC).strftime("%Y.%m.%d") return f"{marketing}-{channel}.{date}.{build_num}+{short}" # ---------------------------------------------------------- # CLEAN # ---------------------------------------------------------- def clean(): run("make clean") def clean_derived_data(): run("rm -rf ~/Library/Developer/Xcode/DerivedData/*", check=False) def clean_spm_cache(): run("rm -rf ~/Library/Caches/org.swift.swiftpm/*", check=False) # ---------------------------------------------------------- # BUILD # ---------------------------------------------------------- def build(): run("mkdir -p build/logs") run( "set -o pipefail && " "NSUnbufferedIO=YES make -B build " "2>&1 | tee -a build/logs/build.log | xcbeautify --renderer github-actions" ) run("make fakesign | tee -a build/logs/build.log") run("make ipa | tee -a build/logs/build.log") run("zip -r -9 ./SideStore.dSYMs.zip ./SideStore.xcarchive/dSYMs") # ---------------------------------------------------------- # TESTS BUILD # ---------------------------------------------------------- def tests_build(): run("mkdir -p build/logs") run( "NSUnbufferedIO=YES make -B build-tests " "2>&1 | tee -a build/logs/tests-build.log | xcbeautify --renderer github-actions" ) # ---------------------------------------------------------- # TESTS RUN # ---------------------------------------------------------- def is_sim_booted(model): out = runAndGet(f'xcrun simctl list devices "{model}"') return "Booted" in out def boot_sim_async(model): log = ROOT / "build/logs/tests-run.log" log.parent.mkdir(parents=True, exist_ok=True) if is_sim_booted(model): run(f'echo "Simulator {model} already booted." | tee -a {log}') return run(f'echo "Booting simulator {model} asynchronously..." | tee -a {log}') with open(log, "a") as f: subprocess.Popen( ["xcrun", "simctl", "boot", model], cwd=ROOT, stdout=f, stderr=subprocess.STDOUT, start_new_session=True, ) def boot_sim_sync(model): run("mkdir -p build/logs") for i in range(1, 7): if is_sim_booted(model): run('echo "Simulator booted." | tee -a build/logs/tests-run.log') return run(f'echo "Simulator not ready (attempt {i}/6), retrying in 10s..." | tee -a build/logs/tests-run.log') time.sleep(10) raise SystemExit("Simulator failed to boot") def tests_run(model): run("mkdir -p build/logs") if not is_sim_booted(model): boot_sim_sync(model) run("make run-tests 2>&1 | tee -a build/logs/tests-run.log") run("zip -r -9 ./test-results.zip ./build/tests") # ---------------------------------------------------------- # LOG ENCRYPTION # ---------------------------------------------------------- def encrypt_logs(name): default_pwd = "12345" pwd = getenv("BUILD_LOG_ZIP_PASSWORD", default_pwd) if pwd == default_pwd: print("Warning: BUILD_LOG_ZIP_PASSWORD not set, using fallback password", file=sys.stderr) run(f'cd build/logs && zip -e -P "{pwd}" ../../{name}.zip *') # ---------------------------------------------------------- # RELEASE NOTES # ---------------------------------------------------------- def release_notes(tag): run( f"python3 {SCRIPTS}/generate_release_notes.py " f"{tag} " f"--repo-root {ROOT} " f"--output-dir {ROOT}" ) # ---------------------------------------------------------- # DEPLOY SOURCE.JSON # ---------------------------------------------------------- def deploy(repo, source_json, release_tag, short_commit, marketing_version, version, channel, bundle_id, ipa_name, last_successful_commit=None): repo = (ROOT / repo).resolve() ipa_path = ROOT / ipa_name source_json_path = repo / source_json metadata = 'source-metadata.json' if not repo.exists(): raise SystemExit(f"{repo} repo missing") if not ipa_path.exists(): raise SystemExit(f"{ipa_path} missing") if not source_json_path.exists(): raise SystemExit(f"{source_json} missing inside repo") cmd = ( f"python3 {SCRIPTS}/generate_source_metadata.py " f"--repo-root {ROOT} " f"--ipa {ipa_path} " f"--output-dir {ROOT} " f"--output-name {metadata} " f"--release-notes-dir {ROOT} " f"--release-tag {release_tag} " f"--version {version} " f"--marketing-version {marketing_version} " f"--short-commit {short_commit} " f"--release-channel {channel} " f"--bundle-id {bundle_id}" ) # pass only if provided if last_successful_commit: cmd += f" --last-successful-commit {last_successful_commit}" run(cmd) run("git config user.name 'GitHub Actions'", check=False) run("git config user.email 'github-actions@github.com'", check=False) max_attempts = 5 for attempt in range(1, max_attempts + 1): if attempt > 1: run("git fetch --depth=1 origin HEAD", check=False, cwd=repo) run("git reset --hard FETCH_HEAD", check=False, cwd=repo) # regenerate after reset so we don't lose changes run(f"python3 {SCRIPTS}/update_source_metadata.py '{ROOT}/{metadata}' '{source_json_path}'") run(f"git add --verbose {source_json}", check=False) run(f"git commit -m '{release_tag} - deployed {version}' || true", check=False) rc = subprocess.call("git push", shell=True) if rc == 0: print("Deploy push succeeded", file=sys.stderr) break print(f"Push rejected (attempt {attempt}/{max_attempts}), retrying...", file=sys.stderr) time.sleep(0.5) else: raise SystemExit("Deploy push failed after retries") def last_successful_commit(workflow, branch): import json try: out = runAndGet( f'gh run list ' f'--workflow "{workflow}" ' f'--json headSha,conclusion,headBranch' ) runs = json.loads(out) for r in runs: if r.get("conclusion") == "success" and r.get("headBranch") == branch: return r["headSha"] except Exception: pass return None def upload_release(release_name, release_tag,is_beta,version,commit_sha,repo,built_date,built_date_alt,upstream_recommendation,release_notes): token = getenv("GH_TOKEN") if token: os.environ["GH_TOKEN"] = token body = textwrap.dedent(f"""\ This is an ⚠️ **EXPERIMENTAL** ⚠️ {release_name} build for commit [{commit_sha}](https://github.com/{repo}/commit/{commit_sha}). {release_name} builds are **extremely experimental builds only meant to be used by developers and beta testers. They often contain bugs and experimental features. Use at your own risk!** {upstream_recommendation} ## Build Info Built at (UTC): `{built_date}` Built at (UTC date): `{built_date_alt}` Commit SHA: `{commit_sha}` Version: `{version}` {release_notes} """) body_file = ROOT / "release_body.md" body_file.write_text(body, encoding="utf-8") prerelease_flag = "--prerelease" if str(is_beta).lower() in ["true", "1", "yes"] else "" run( f'gh release edit "{release_tag}" ' f'--title "{release_name}" ' f'--notes-file "{body_file}" ' f'{prerelease_flag}' ) run( f'gh release upload "{release_tag}" ' f'SideStore.ipa SideStore.dSYMs.zip ' f'--clobber' ) # ---------------------------------------------------------- # ENTRYPOINT # ---------------------------------------------------------- COMMANDS = { # ---------------------------------------------------------- # SHARED # ---------------------------------------------------------- "commid-id" : (short_commit, 0, ""), # ---------------------------------------------------------- # PROJECT INFO # ---------------------------------------------------------- "get-marketing-version" : (get_marketing_version, 0, ""), "set-marketing-version" : (set_marketing_version, 1, ""), "compute-qualified" : (compute_qualified_version, 4, " "), "reserve_build_number" : (reserve_build_number, 1, ""), "get-product-name" : (get_product_name, 0, ""), "get-bundle-id" : (get_bundle_id, 0, ""), # ---------------------------------------------------------- # CLEAN # ---------------------------------------------------------- "clean" : (clean, 0, ""), "clean-derived-data" : (clean_derived_data, 0, ""), "clean-spm-cache" : (clean_spm_cache, 0, ""), # ---------------------------------------------------------- # BUILD # ---------------------------------------------------------- "build" : (build, 0, ""), # ---------------------------------------------------------- # TESTS # ---------------------------------------------------------- "tests-build" : (tests_build, 0, ""), "tests-run" : (tests_run, 1, ""), "boot-sim-async" : (boot_sim_async, 1, ""), "boot-sim-sync" : (boot_sim_sync, 1, ""), # ---------------------------------------------------------- # LOG ENCRYPTION # ---------------------------------------------------------- "encrypt-build" : (lambda: encrypt_logs("encrypted-build-logs"), 0, ""), "encrypt-tests-build" : (lambda: encrypt_logs("encrypted-tests-build-logs"), 0, ""), "encrypt-tests-run" : (lambda: encrypt_logs("encrypted-tests-run-logs"), 0, ""), # ---------------------------------------------------------- # RELEASE / DEPLOY # ---------------------------------------------------------- "last-successful-commit" : (last_successful_commit, 2, " "), "release-notes" : (release_notes, 1, ""), "deploy" : (deploy, 10, " [last_successful_commit]"), "upload-release" : (upload_release, 9, " "), } def main(): def usage(): lines = ["Available commands:"] for name, (_, argc, arg_usage) in COMMANDS.items(): suffix = f" {arg_usage}" if arg_usage else "" lines.append(f" - {name}{suffix}") return "\n".join(lines) if len(sys.argv) < 2: raise SystemExit(usage()) cmd = sys.argv[1] if cmd not in COMMANDS: raise SystemExit( f"Unknown command '{cmd}'.\n\n{usage()}" ) func, argc, arg_usage = COMMANDS[cmd] if len(sys.argv) - 2 < argc: suffix = f" {arg_usage}" if arg_usage else "" raise SystemExit(f"Usage: workflow.py {cmd}{suffix}") args = sys.argv[2:2 + argc] result = func(*args) if argc else func() # ONLY real outputs go to stdout if result is not None: sys.stdout.write(str(result)) sys.stdout.flush() if __name__ == "__main__": main()