73a1787eb8
## Summary - update the README install snippets to use `brew install --cask codex` - mirror the same change in the Rust CLI README Address #5317 https://chatgpt.com/codex/tasks/task_i_68f65682543083269254cd64d290df28 --------- Co-authored-by: pakrym-oai <pakrym@openai.com>
46 lines
1.8 KiB
Markdown
46 lines
1.8 KiB
Markdown
# Release Management
|
|
|
|
Currently, we made Codex binaries available in three places:
|
|
|
|
- GitHub Releases https://github.com/openai/codex/releases/
|
|
- `@openai/codex` on npm: https://www.npmjs.com/package/@openai/codex
|
|
- `codex` on Homebrew: https://formulae.brew.sh/cask/codex
|
|
|
|
# Cutting a Release
|
|
|
|
Run the `codex-rs/scripts/create_github_release` script in the repository to publish a new release. The script will choose the appropriate version number depending on the type of release you are creating.
|
|
|
|
To cut a new alpha release from `main` (feel free to cut alphas liberally):
|
|
|
|
```
|
|
./codex-rs/scripts/create_github_release --publish-alpha
|
|
```
|
|
|
|
To cut a new _public_ release from `main` (which requires more caution), run:
|
|
|
|
```
|
|
./codex-rs/scripts/create_github_release --publish-release
|
|
```
|
|
|
|
TIP: Add the `--dry-run` flag to report the next version number for the respective release and exit.
|
|
|
|
Running the publishing script will kick off a GitHub Action to build the release, so go to https://github.com/openai/codex/actions/workflows/rust-release.yml to find the corresponding workflow. (Note: we should automate finding the workflow URL with `gh`.)
|
|
|
|
When the workflow finishes, the GitHub Release is "done," but you still have to consider npm and Homebrew.
|
|
|
|
## Publishing to npm
|
|
|
|
The GitHub Action is responsible for publishing to npm.
|
|
|
|
## Publishing to Homebrew
|
|
|
|
For Homebrew, we ship Codex as a cask. Homebrew's automation system checks our GitHub repo every few hours for a new release and will open a PR to update the cask with the latest binary.
|
|
|
|
Inevitably, you just have to refresh this page periodically to see if the release has been picked up by their automation system:
|
|
|
|
https://github.com/Homebrew/homebrew-cask/pulls?q=%3Apr+codex
|
|
|
|
For reference, our Homebrew cask lives at:
|
|
|
|
https://github.com/Homebrew/homebrew-cask/blob/main/Casks/c/codex.rb
|