mirror of
https://github.com/openai/codex.git
synced 2026-11-19 22:30:42 +00:00
build: add Codex package builder
This commit is contained in:
@@ -0,0 +1,48 @@
|
||||
# Codex package builder
|
||||
|
||||
This package contains the implementation behind `scripts/build_codex_package.py`.
|
||||
The top-level script is the stable executable entry point; these modules keep the
|
||||
package-building logic split by responsibility.
|
||||
|
||||
The builder creates a canonical Codex package directory:
|
||||
|
||||
```text
|
||||
.
|
||||
├── codex-package.json
|
||||
├── bin
|
||||
│ └── codex[.exe]
|
||||
├── codex-resources
|
||||
│ ├── bwrap # Linux only
|
||||
│ ├── codex-command-runner.exe # Windows only
|
||||
│ └── codex-windows-sandbox-setup.exe # Windows only
|
||||
└── codex-path
|
||||
└── rg[.exe]
|
||||
```
|
||||
|
||||
The package directory is the primary artifact. Archive formats such as
|
||||
`.tar.gz`, `.tar.zst`, and `.zip` are serializations of that directory.
|
||||
|
||||
## Module layout
|
||||
|
||||
- `cli.py`: argparse setup and command orchestration.
|
||||
- `cargo.py`: grouped `cargo build` invocation for artifacts built from this
|
||||
repository.
|
||||
- `targets.py`: supported target triples and non-source artifact discovery.
|
||||
- `layout.py`: package directory creation and validation.
|
||||
- `archive.py`: archive writers.
|
||||
|
||||
## Source-built artifacts
|
||||
|
||||
Artifacts built from this repository are always built by the package builder in
|
||||
one grouped `cargo build` command per package:
|
||||
|
||||
- all targets: `codex`
|
||||
- Linux targets: `bwrap`
|
||||
- Windows targets: `codex-command-runner` and `codex-windows-sandbox-setup`
|
||||
|
||||
The default cargo profile is `dev-small` because local iteration should favor
|
||||
fast, small builds. Release jobs should pass `--cargo-profile release`.
|
||||
|
||||
`rg` is not built from this repository, so it remains an input. If `--rg-bin` is
|
||||
omitted, the builder looks in the existing `codex-cli/vendor/<target>/path/`
|
||||
location.
|
||||
Reference in New Issue
Block a user