Files
pages-cli/DISTRIBUTION.md
T

41 lines
3.7 KiB
Markdown

# CLIのダウンロードと配布
配布先はGiteaの `anya/pages-cli` のReleases。CLIはサーバーとは独立したSemVerで、最初の独立配布版はv0.1.0。対応APIがあるサーバーが必要で、タスク・連絡先を含む利用ではPagesWiki v0.6.0以降を基準とする。ユーザーの設定やセッションは既存のまま利用できる。
## 対象OS
| 対象 | 配布状態と条件 |
| --- | --- |
| Linux/amd64 | ELF単体とtar.gz。glibc 2.36以降(Debian 12、Ubuntu 24.04等)。Python同梱。Alpine/muslは対象外 |
| macOS | Unixソース対応。配布バイナリはmacOS runner接続後にネイティブビルド・実機検証する。署名・公証は別途必要 |
| Windows/amd64 | 配布準備の対象。fcntl、readline、所有者・0600権限検証のWindows移植とネイティブ検証が必要。未対応exeは公開しない |
rpm/debは初期配布の必須条件にせず、LinuxはELFを提供する。PyInstallerはクロスコンパイラではないため、macOS/WindowsバイナリをLinux上で作ったとみなさない。[公式説明](https://www.pyinstaller.org/en/stable/)
## インストール
Releases画面からOSに合うtar.gzと `*-SHA256SUMS` をダウンロードする。非公開リポジトリではGiteaへのログインが必要。資格情報をコマンドライン引数や公開URLに埋め込まない。
```sh
# ダウンロード先で実行。手元にあるファイルをチェックする。
sha256sum --ignore-missing -c pages-cli-v0.1.0-linux-amd64-SHA256SUMS
tar -xzf pages-cli-v0.1.0-linux-amd64.tar.gz
mkdir -p ~/.local/bin
install -m 755 pages ~/.local/bin/pages
pages --version
```
SHA-256はダウンロード内容の整合確認であり、配布者の暗号学的署名ではない。ELF単体を取得した場合も同じSHA256SUMSで確認し、実行権限を付ける。設定・ログイン手順は[README](README.md)を参照。`PAGER`・`EDITOR`、TLS用のOS信頼ストアは利用環境側に必要で、バイナリはOSのlibcなどへ動的リンクする。
## ビルドとリリース
LinuxのCIはGitea Actionsでテスト後、Dockerfile.releaseからPython同梱ELFを作り、versionとhelpを起動確認する。`VERSION` とソースのVERSIONは一致必須。ビルドメタデータ、ソース版、tar.gz、実行ファイル、SHA256SUMSを出力する。ソース版に設定・トークン・ユーザーデータは含めない。
mainへのpushはテスト・ビルドのみ。`vX.Y.Z` タグのpushは同じ処理に加えてGitea Releaseへ添付し、全ファイルの転送後にdraftを解除する。同じ名前の既存添付はハッシュが一致する場合だけ再利用し、相違があれば停止する。公開タグは付け替えない。
既存runnerにはdocker/buildxとGiteaへのHTTPS接続が必要。公開にはジョブのtokenを使用し、権限不足の場合だけこのリポジトリに限定した `CLI_RELEASE_TOKEN` を設定する。サーバーリポジトリのPATやDocker資格情報をコピーしない。
macOSは `CLI_MACOS_ENABLED=true` と `CLI_MACOS_RUNNER_LABEL` を設定した場合のみ起動する。runnerにはPython 3とgitが必要で、タグcheckout後に同じbuild.pyを実行する。Macの最低OS、CPU、署名・公証は実際のrunnerと検証結果に合わせて公開時に明記する。Windowsは安全な資格情報保存の移植が済むまでジョブを有効化しない。
サーバーリポジトリ側の旧pages-cliは結合テスト用スナップショット。CLIの新規実装・配布はこのリポジトリで行い、サーバーの結合テスト用コピーはレビューしたリビジョンに明示的に更新する。