mirror of
https://github.com/openai/codex.git
synced 2026-05-20 19:23:21 +00:00
7f4d7ae3a4
## Why Codex CLI packaging is currently split across npm staging, standalone installers, and release bundle creation, which makes it hard to define and validate a single valid package directory. This adds the first standalone package builder so later release paths can converge on the same canonical layout. ## What changed - Added `scripts/build_codex_package.py` as the stable executable wrapper around `scripts/codex_package`. - Added modules for CLI parsing, target metadata, grouped cargo builds, package layout validation, and archive writing. - The builder creates a package directory with `codex-package.json`, `bin/`, `codex-resources/`, and `codex-path`, and can serialize it as `.tar.gz`, `.tar.zst`, or `.zip`. - Source-built artifacts are built by one grouped `cargo build`: `codex` for all targets, `bwrap` for Linux, and the Windows sandbox helpers for Windows. `rg` remains an input because it is vendored from upstream rather than built from this repo. - Added `scripts/codex_package/README.md` to document the package layout, source-built artifacts, and cargo profile behavior. ## Verification - Ran wrapper/module syntax compilation. - Ran `scripts/build_codex_package.py --help` from `/private/tmp`. - Ran fake-cargo package/archive builds for macOS, Linux, and Windows target layouts, including an assertion that generated tar archives contain no duplicate member names. --- [//]: # (BEGIN SAPLING FOOTER) Stack created with [Sapling](https://sapling-scm.com). Best reviewed with [ReviewStack](https://reviewstack.dev/openai/codex/pull/23513). * #23526 * __->__ #23513
88 lines
3.0 KiB
Python
88 lines
3.0 KiB
Python
"""Archive writers for canonical Codex package directories."""
|
|
|
|
import shutil
|
|
import subprocess
|
|
import tarfile
|
|
import tempfile
|
|
import zipfile
|
|
from pathlib import Path
|
|
|
|
|
|
def write_archive(package_dir: Path, archive_path: Path, *, force: bool) -> None:
|
|
if is_relative_to(archive_path, package_dir):
|
|
raise RuntimeError(
|
|
f"Archive output must be outside the package directory: {archive_path}"
|
|
)
|
|
|
|
archive_path.parent.mkdir(parents=True, exist_ok=True)
|
|
if archive_path.exists():
|
|
if not force:
|
|
raise RuntimeError(f"Archive output already exists: {archive_path}")
|
|
archive_path.unlink()
|
|
|
|
archive_format = archive_format_for_path(archive_path)
|
|
if archive_format == "tar.gz":
|
|
write_tar_archive(package_dir, archive_path, mode="w:gz")
|
|
elif archive_format == "tar.zst":
|
|
write_tar_zst_archive(package_dir, archive_path)
|
|
elif archive_format == "zip":
|
|
write_zip_archive(package_dir, archive_path)
|
|
else:
|
|
raise AssertionError(f"unexpected archive format: {archive_format}")
|
|
|
|
|
|
def is_relative_to(path: Path, parent: Path) -> bool:
|
|
try:
|
|
path.relative_to(parent)
|
|
return True
|
|
except ValueError:
|
|
return False
|
|
|
|
|
|
def archive_format_for_path(path: Path) -> str:
|
|
suffixes = path.suffixes
|
|
if suffixes[-2:] == [".tar", ".gz"] or path.suffix == ".tgz":
|
|
return "tar.gz"
|
|
if suffixes[-2:] == [".tar", ".zst"]:
|
|
return "tar.zst"
|
|
if path.suffix == ".zip":
|
|
return "zip"
|
|
raise RuntimeError(
|
|
f"Unsupported archive suffix for {path}. Use .tar.gz, .tgz, .tar.zst, or .zip."
|
|
)
|
|
|
|
|
|
def write_tar_archive(package_dir: Path, archive_path: Path, *, mode: str) -> None:
|
|
with tarfile.open(archive_path, mode) as archive:
|
|
for path in package_entries(package_dir):
|
|
archive.add(
|
|
path,
|
|
arcname=path.relative_to(package_dir),
|
|
recursive=False,
|
|
)
|
|
|
|
|
|
def write_tar_zst_archive(package_dir: Path, archive_path: Path) -> None:
|
|
zstd = shutil.which("zstd")
|
|
if zstd is None:
|
|
raise RuntimeError("zstd is required to write .tar.zst archives.")
|
|
|
|
with tempfile.TemporaryDirectory(prefix="codex-package-archive-") as temp_dir_str:
|
|
tar_path = Path(temp_dir_str) / "package.tar"
|
|
write_tar_archive(package_dir, tar_path, mode="w")
|
|
subprocess.check_call([zstd, "-T0", "-19", "-f", str(tar_path), "-o", str(archive_path)])
|
|
|
|
|
|
def write_zip_archive(package_dir: Path, archive_path: Path) -> None:
|
|
with zipfile.ZipFile(archive_path, "w", compression=zipfile.ZIP_DEFLATED) as archive:
|
|
for path in package_entries(package_dir):
|
|
relative_path = path.relative_to(package_dir)
|
|
if path.is_dir():
|
|
archive.write(path, f"{relative_path}/")
|
|
else:
|
|
archive.write(path, relative_path)
|
|
|
|
|
|
def package_entries(package_dir: Path) -> list[Path]:
|
|
return sorted(package_dir.rglob("*"), key=lambda path: path.relative_to(package_dir).as_posix())
|