Skip to content

Commit 03c4e8a

Browse files
committed
docs(macos): explain packaged release assets
1 parent 32642c0 commit 03c4e8a

6 files changed

Lines changed: 51 additions & 4 deletions

File tree

‎README.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,10 @@ bun run build:macos
7777
open "dist/macos/OpenCodex.app"
7878
```
7979

80+
Non-dry-run GitHub releases include a Universal macOS archive named
81+
`OpenCodex-<version>-macOS-universal.zip` plus its SHA-256 checksum. The archive is ad-hoc signed
82+
and not notarized, so macOS may require manual approval on first launch.
83+
8084
The companion uses the installed `ocx` CLI as its control boundary and never edits PID files or
8185
Codex configuration directly. See the [macOS menu bar guide](https://lidge-jun.github.io/opencodex/guides/macos-menu-bar/)
8286
for CLI discovery, universal builds, and launch-at-login setup.

‎docs-site/src/content/docs/guides/macos-menu-bar.md‎

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,18 @@ to build arm64 and x86_64 together (Command Line Tools alone only supports the c
2323
UNIVERSAL=1 bun run build:macos
2424
```
2525

26-
The output is ad-hoc signed for local use. Production distribution still requires the maintainer's
27-
Developer ID signing and notarization flow.
26+
The output is ad-hoc signed for local use. A warning-free public distribution still requires the
27+
maintainer's Developer ID signing and notarization flow.
28+
29+
## Release packaging
30+
31+
The Release workflow builds both arm64 and x86_64, packages `OpenCodex.app` as
32+
`OpenCodex-<version>-macOS-universal.zip`, and generates a matching `.sha256` file. Dry runs build,
33+
transfer, and verify both files as workflow artifacts. Non-dry-run releases attach them to the
34+
GitHub Release after npm publishing succeeds.
35+
36+
The automated archive is ad-hoc signed and not notarized, so macOS may require manual approval on
37+
first launch.
2838

2939
## Menu actions
3040

‎docs-site/src/content/docs/ja/guides/macos-menu-bar.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,14 @@ open "dist/macos/OpenCodex.app"
1919
作成できます。Command Line Tools だけの場合は現在のアーキテクチャのみです。出力はローカル実行用に
2020
ad-hoc 署名され、配布には Developer ID 署名と notarization が別途必要です。
2121

22+
## リリースパッケージ
23+
24+
Release ワークフローは arm64 と x86_64 をまとめてビルドし、`OpenCodex.app` を
25+
`OpenCodex-<version>-macOS-universal.zip` に圧縮して対応する `.sha256` を生成します。
26+
ドライランでも両ファイルをワークフロー artifact として転送・検証し、実際のリリースでは npm 公開の
27+
成功後に GitHub Release へ添付します。自動生成アーカイブは ad-hoc 署名で notarization されていないため、
28+
初回起動時に macOS で手動承認が必要になる場合があります。
29+
2230
アプリは `ocx status --json` を読み、既存 CLI に起動・再起動・終了を委譲します。終了と再起動は
2331
進行中のリクエストを中断する可能性があるため確認ダイアログを表示します。メニューバーアプリだけを
2432
終了してもプロキシは停止しません。

‎docs-site/src/content/docs/ko/guides/macos-menu-bar.md‎

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,18 @@ x86_64를 함께 넣으려면 다음처럼 빌드합니다. Command Line Tools
2323
UNIVERSAL=1 bun run build:macos
2424
```
2525

26-
로컬 실행용 ad-hoc 서명까지 자동으로 적용됩니다. 외부 배포용 앱은 메인테이너의 Developer ID 서명과
27-
notarization 절차가 별도로 필요합니다.
26+
로컬 실행용 ad-hoc 서명까지 자동으로 적용됩니다. 경고 없이 외부에 배포하려면 메인테이너의
27+
Developer ID 서명과 notarization 절차가 별도로 필요합니다.
28+
29+
## 릴리즈 패키징
30+
31+
Release 워크플로는 arm64와 x86_64를 함께 빌드하고 `OpenCodex.app`을
32+
`OpenCodex-<version>-macOS-universal.zip`으로 압축한 뒤 대응하는 `.sha256` 파일을 생성합니다.
33+
드라이런에서도 두 파일을 워크플로 아티팩트로 전달하고 검증합니다. 실제 릴리즈에서는 npm 배포가
34+
성공한 후 두 파일을 GitHub Release에 첨부합니다.
35+
36+
자동 생성된 압축 파일은 ad-hoc 서명 상태이며 notarization되지 않으므로, 첫 실행 때 macOS에서
37+
수동 승인이 필요할 수 있습니다.
2838

2939
## 메뉴 동작
3040

‎docs-site/src/content/docs/ru/guides/macos-menu-bar.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,14 @@ open "dist/macos/OpenCodex.app"
2020
x86_64 вместе; одних Command Line Tools достаточно только для текущей архитектуры. Результат получает
2121
ad-hoc подпись для локального запуска; для распространения нужны Developer ID и notarization.
2222

23+
## Пакет для релиза
24+
25+
Workflow Release собирает arm64 и x86_64 вместе, упаковывает `OpenCodex.app` в
26+
`OpenCodex-<version>-macOS-universal.zip` и создаёт соответствующий файл `.sha256`. При dry run оба
27+
файла передаются и проверяются как workflow artifacts; в настоящем релизе они прикрепляются к
28+
GitHub Release после успешной публикации npm. Архив имеет ad-hoc подпись и не notarized, поэтому при
29+
первом запуске macOS может потребовать ручное подтверждение.
30+
2331
Приложение читает `ocx status --json` и делегирует запуск, перезапуск и остановку существующему CLI.
2432
Перед перезапуском и остановкой показывается подтверждение, поскольку активные запросы могут быть
2533
прерваны. Выход только из приложения строки меню не останавливает прокси.

‎docs-site/src/content/docs/zh-cn/guides/macos-menu-bar.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,13 @@ open "dist/macos/OpenCodex.app"
1919
只有 Command Line Tools 时只能构建当前架构。产物会进行本地使用的 ad-hoc 签名;正式分发仍需要
2020
Developer ID 签名和 notarization。
2121

22+
## 发布打包
23+
24+
Release 工作流会同时构建 arm64 和 x86_64,将 `OpenCodex.app` 打包为
25+
`OpenCodex-<version>-macOS-universal.zip`,并生成对应的 `.sha256` 文件。Dry run 也会把两个文件
26+
作为工作流 artifact 传递并验证;正式发布时,则会在 npm 发布成功后将其附加到 GitHub Release。
27+
自动生成的压缩包使用 ad-hoc 签名且未 notarization,因此首次启动时 macOS 可能要求手动批准。
28+
2229
应用读取 `ocx status --json`,并把启动、重启和停止操作交给现有 CLI。重启和停止可能中断进行中的
2330
请求,因此会先显示确认对话框。退出菜单栏应用本身不会停止代理。
2431

0 commit comments

Comments
 (0)