From a0fa31aad17ccf90d13ddf2c8a4a7fa7f6499ed6 Mon Sep 17 00:00:00 2001 From: Duc Nguyen Date: Mon, 22 Jun 2026 18:00:22 +0700 Subject: [PATCH] feat: add install.sh for one-line release install (#157) * feat: add install.sh for one-line release install Add a POSIX install script that detects OS/arch, resolves the latest release (override with OCR_VERSION), verifies the SHA-256 checksum fail-closed, and installs the ocr binary to /usr/local/bin (override with OCR_INSTALL_DIR, sudo fallback when needed). README now leads with a single curl | sh command and keeps the manual per-platform downloads in a collapsible section for Windows and offline use. * fix: harden install.sh shell robustness - replace word-split $SHA_CMD invocation with a sha256() wrapper function - capture github api response and fail explicitly on curl error instead of masking it through the tag-parsing pipeline under set -eu * fix: harden install.sh from local ocr review - trap INT/TERM in addition to EXIT so the temp dir is cleaned on signals - install binary with install(1) so sudo installs are root-owned in system dirs - make sha256() self-contained (errors if no checksum tool) and drop the now redundant up-front guard * docs(i18n): sync install one-liner to localized READMEs Apply the same GitHub Release install-section change as README.md to the zh-CN/ja-JP/ko-KR/ru-RU translations: lead with the curl|sh one-liner plus OCR_INSTALL_DIR/OCR_VERSION override example, and move the per-platform manual downloads into a
block. --- README.ja-JP.md | 20 +++++++++- README.ko-KR.md | 20 +++++++++- README.md | 20 +++++++++- README.ru-RU.md | 20 +++++++++- README.zh-CN.md | 20 +++++++++- install.sh | 97 +++++++++++++++++++++++++++++++++++++++++++++++++ 6 files changed, 192 insertions(+), 5 deletions(-) create mode 100755 install.sh diff --git a/README.ja-JP.md b/README.ja-JP.md index d1e2bfd..38e88e5 100644 --- a/README.ja-JP.md +++ b/README.ja-JP.md @@ -95,7 +95,23 @@ npm install -g @alibaba-group/open-code-review **GitHub Releaseから** -[GitHub Releases](https://github.com/alibaba/open-code-review/releases)から最新のバイナリをダウンロードします： +1 つのコマンドで、お使いの OS / アーキテクチャ向けの最新バイナリをインストールできます（macOS / Linux）： + +```bash +curl -fsSL https://raw.githubusercontent.com/alibaba/open-code-review/main/install.sh | sh +``` + +このスクリプトは適切なリリースバイナリを選択し、SHA-256 チェックサムを検証して、`ocr` として `/usr/local/bin` にインストールします。インストール先は `OCR_INSTALL_DIR` で、リリースバージョンは `OCR_VERSION` で上書きできます： + +```bash +OCR_INSTALL_DIR="$HOME/.local/bin" OCR_VERSION=v1.3.13 \ + sh -c "$(curl -fsSL https://raw.githubusercontent.com/alibaba/open-code-review/main/install.sh)" +``` + +
+手動ダウンロード（Windows を含む全プラットフォーム） + +[GitHub Releases](https://github.com/alibaba/open-code-review/releases)からお使いのプラットフォーム向けのバイナリをダウンロードします： ```bash # macOS (Apple Silicon) @@ -121,6 +137,8 @@ curl -Lo ocr.exe https://github.com/alibaba/open-code-review/releases/latest/dow curl -Lo ocr.exe https://github.com/alibaba/open-code-review/releases/latest/download/opencodereview-windows-arm64.exe ``` +
+ **ソースから** ```bash diff --git a/README.ko-KR.md b/README.ko-KR.md index c1470a4..92f6a05 100644 --- a/README.ko-KR.md +++ b/README.ko-KR.md @@ -95,7 +95,23 @@ npm install -g @alibaba-group/open-code-review **GitHub Release 사용** -[GitHub Releases](https://github.com/alibaba/open-code-review/releases)에서 최신 binary를 다운로드합니다. +명령 한 번으로 사용 중인 OS/아키텍처에 맞는 최신 binary를 설치합니다 (macOS / Linux): + +```bash +curl -fsSL https://raw.githubusercontent.com/alibaba/open-code-review/main/install.sh | sh +``` + +이 스크립트는 알맞은 릴리스 binary를 선택하고 SHA-256 체크섬을 검증한 뒤 `ocr`로 `/usr/local/bin`에 설치합니다. 설치 위치는 `OCR_INSTALL_DIR`로, 릴리스 버전은 `OCR_VERSION`으로 재정의할 수 있습니다: + +```bash +OCR_INSTALL_DIR="$HOME/.local/bin" OCR_VERSION=v1.3.13 \ + sh -c "$(curl -fsSL https://raw.githubusercontent.com/alibaba/open-code-review/main/install.sh)" +``` + +
+수동 다운로드 (Windows 포함 모든 플랫폼) + +[GitHub Releases](https://github.com/alibaba/open-code-review/releases)에서 사용 중인 플랫폼의 binary를 다운로드합니다. ```bash # macOS (Apple Silicon) @@ -121,6 +137,8 @@ curl -Lo ocr.exe https://github.com/alibaba/open-code-review/releases/latest/dow curl -Lo ocr.exe https://github.com/alibaba/open-code-review/releases/latest/download/opencodereview-windows-arm64.exe ``` +
+ **소스에서 빌드** ```bash diff --git a/README.md b/README.md index 5c87163..81f6ccf 100644 --- a/README.md +++ b/README.md @@ -95,7 +95,23 @@ After installation, the `ocr` command is available globally. **From GitHub Release** -Download the latest binary from [GitHub Releases](https://github.com/alibaba/open-code-review/releases): +Install the latest binary for your OS/architecture with one command (macOS / Linux): + +```bash +curl -fsSL https://raw.githubusercontent.com/alibaba/open-code-review/main/install.sh | sh +``` + +The script picks the right release binary, verifies its SHA-256 checksum, and installs it as `ocr` in `/usr/local/bin`. Override the target with `OCR_INSTALL_DIR` or pin a release with `OCR_VERSION`: + +```bash +OCR_INSTALL_DIR="$HOME/.local/bin" OCR_VERSION=v1.3.13 \ + sh -c "$(curl -fsSL https://raw.githubusercontent.com/alibaba/open-code-review/main/install.sh)" +``` + +
+Manual download (all platforms, including Windows) + +Download the binary for your platform from [GitHub Releases](https://github.com/alibaba/open-code-review/releases): ```bash # macOS (Apple Silicon) @@ -121,6 +137,8 @@ curl -Lo ocr.exe https://github.com/alibaba/open-code-review/releases/latest/dow curl -Lo ocr.exe https://github.com/alibaba/open-code-review/releases/latest/download/opencodereview-windows-arm64.exe ``` +
+ **From Source** ```bash diff --git a/README.ru-RU.md b/README.ru-RU.md index 7b4950f..94bc1ce 100644 --- a/README.ru-RU.md +++ b/README.ru-RU.md @@ -95,7 +95,23 @@ npm install -g @alibaba-group/open-code-review **Из GitHub Release** -Скачайте свежий бинарный файл со страницы [GitHub Releases](https://github.com/alibaba/open-code-review/releases): +Установите свежий бинарный файл для вашей ОС/архитектуры одной командой (macOS / Linux): + +```bash +curl -fsSL https://raw.githubusercontent.com/alibaba/open-code-review/main/install.sh | sh +``` + +Скрипт сам выбирает подходящий бинарный файл релиза, проверяет его контрольную сумму SHA-256 и устанавливает его как `ocr` в `/usr/local/bin`. Каталог установки можно переопределить через `OCR_INSTALL_DIR`, а версию релиза зафиксировать через `OCR_VERSION`: + +```bash +OCR_INSTALL_DIR="$HOME/.local/bin" OCR_VERSION=v1.3.13 \ + sh -c "$(curl -fsSL https://raw.githubusercontent.com/alibaba/open-code-review/main/install.sh)" +``` + +
+Ручная загрузка (все платформы, включая Windows) + +Скачайте бинарный файл для вашей платформы со страницы [GitHub Releases](https://github.com/alibaba/open-code-review/releases): ```bash # macOS (Apple Silicon) @@ -121,6 +137,8 @@ curl -Lo ocr.exe https://github.com/alibaba/open-code-review/releases/latest/dow curl -Lo ocr.exe https://github.com/alibaba/open-code-review/releases/latest/download/opencodereview-windows-arm64.exe ``` +
+ **Из исходников** ```bash diff --git a/README.zh-CN.md b/README.zh-CN.md index 6ac64ea..ba4eba1 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -95,7 +95,23 @@ npm install -g @alibaba-group/open-code-review **从 GitHub Release 下载** -从 [GitHub Releases](https://github.com/alibaba/open-code-review/releases) 下载最新二进制文件： +使用一条命令为你的操作系统/架构安装最新二进制文件（macOS / Linux）： + +```bash +curl -fsSL https://raw.githubusercontent.com/alibaba/open-code-review/main/install.sh | sh +``` + +该脚本会自动选择匹配的发布二进制文件，校验其 SHA-256 校验和，并将其作为 `ocr` 安装到 `/usr/local/bin`。可通过 `OCR_INSTALL_DIR` 覆盖安装目录，或通过 `OCR_VERSION` 指定发布版本： + +```bash +OCR_INSTALL_DIR="$HOME/.local/bin" OCR_VERSION=v1.3.13 \ + sh -c "$(curl -fsSL https://raw.githubusercontent.com/alibaba/open-code-review/main/install.sh)" +``` + +
+手动下载（所有平台，包括 Windows） + +从 [GitHub Releases](https://github.com/alibaba/open-code-review/releases) 下载适用于你平台的二进制文件： ```bash # macOS (Apple Silicon) @@ -121,6 +137,8 @@ curl -Lo ocr.exe https://github.com/alibaba/open-code-review/releases/latest/dow curl -Lo ocr.exe https://github.com/alibaba/open-code-review/releases/latest/download/opencodereview-windows-arm64.exe ``` +
+ **从源码构建** ```bash diff --git a/install.sh b/install.sh new file mode 100755 index 0000000..8ca887f --- /dev/null +++ b/install.sh @@ -0,0 +1,97 @@ +#!/bin/sh +# Install the ocr (Open Code Review) CLI from GitHub releases. +# curl -fsSL https://raw.githubusercontent.com/alibaba/open-code-review/main/install.sh | sh +# Env: OCR_INSTALL_DIR (default /usr/local/bin), OCR_VERSION (default latest). +set -eu + +main() { + REPO="alibaba/open-code-review" + BIN="ocr" + ASSET_PREFIX="opencodereview" + INSTALL_DIR="${OCR_INSTALL_DIR:-/usr/local/bin}" + VERSION="${OCR_VERSION:-}" + + command -v curl >/dev/null 2>&1 || err "curl is required" + + os="$(uname -s | tr '[:upper:]' '[:lower:]')" + case "$os" in + darwin|linux) ;; + *) err "unsupported OS: $os (download the Windows binary from GitHub releases)" ;; + esac + + arch="$(uname -m)" + case "$arch" in + x86_64|amd64) arch="amd64" ;; + arm64|aarch64) arch="arm64" ;; + *) err "unsupported architecture: $arch" ;; + esac + + if [ -z "$VERSION" ]; then + release_json="$(curl -fsSL "https://api.github.com/repos/$REPO/releases/latest")" || + err "failed to fetch latest release info from github api" + VERSION="$(printf '%s' "$release_json" | + sed -n 's/.*"tag_name"[[:space:]]*:[[:space:]]*"\([^"]*\)".*/\1/p' | head -n1)" + [ -n "$VERSION" ] || err "could not resolve latest release tag" + fi + + asset="${ASSET_PREFIX}-${os}-${arch}" + base="https://github.com/$REPO/releases/download/$VERSION" + tmp="$(mktemp -d)" + trap 'rm -rf "$tmp"' INT TERM EXIT + + printf 'downloading %s %s (%s/%s)...\n' "$BIN" "$VERSION" "$os" "$arch" + curl -fsSL -o "$tmp/$asset" "$base/$asset" || err "download failed: $base/$asset" + curl -fsSL -o "$tmp/sha256sum.txt" "$base/sha256sum.txt" || err "sha256sum.txt download failed" + + want="$(awk -v a="$asset" '$2 == a {print tolower($1)}' "$tmp/sha256sum.txt")" + [ -n "$want" ] || err "no checksum entry for $asset in sha256sum.txt" + got="$(sha256 "$tmp/$asset" | awk '{print tolower($1)}')" + [ "$got" = "$want" ] || err "checksum mismatch for $asset (got $got, want $want)" + + install_binary "$tmp/$asset" "$INSTALL_DIR" "$BIN" + + printf 'installed %s %s -> %s\n' "$BIN" "$VERSION" "$INSTALL_DIR/$BIN" + post_install_path_notice "$BIN" "$INSTALL_DIR" +} + +# Install the staged binary (mode 0755), escalating with sudo only when needed. +# Using install(1) under sudo gives the binary root ownership in system dirs. +install_binary() { + src="$1" + dir="$2" + bin="$3" + if mkdir -p "$dir" 2>/dev/null && [ -w "$dir" ]; then + install -m 0755 "$src" "$dir/$bin" + elif command -v sudo >/dev/null 2>&1; then + printf 'note: %s is not writable; escalating with sudo\n' "$dir" + sudo mkdir -p "$dir" + sudo install -m 0755 "$src" "$dir/$bin" + else + err "$dir is not writable and sudo is unavailable; set OCR_INSTALL_DIR to a writable path" + fi +} + +post_install_path_notice() { + bin="$1" + install_dir="$2" + case ":$PATH:" in + *":$install_dir:"*) ;; + *) printf 'note: %s is not on your PATH; add it or run %s/%s directly\n' "$install_dir" "$install_dir" "$bin"; return ;; + esac + command -v "$bin" >/dev/null 2>&1 || printf 'note: open a new shell so %s resolves on PATH\n' "$bin" +} + +# Print the SHA-256 of a file, preferring shasum (macOS) over sha256sum (Linux). +sha256() { + if command -v shasum >/dev/null 2>&1; then + shasum -a 256 "$1" + elif command -v sha256sum >/dev/null 2>&1; then + sha256sum "$1" + else + err "shasum or sha256sum is required for checksum verification" + fi +} + +err() { printf 'error: %s\n' "$1" >&2; exit 1; } + +main "$@"