From 50910b375301b1732c3f0b9467880e1a8a298263 Mon Sep 17 00:00:00 2001 From: Ragnor Comerford Date: Fri, 29 May 2026 14:03:59 +0200 Subject: [PATCH] docs: align release artifact docs --- docs/dev/ci.md | 4 ++-- docs/user/deployment.md | 6 +++--- docs/user/install.md | 1 - 3 files changed, 5 insertions(+), 6 deletions(-) diff --git a/docs/dev/ci.md b/docs/dev/ci.md index 010d2df..8495d5e 100644 --- a/docs/dev/ci.md +++ b/docs/dev/ci.md @@ -5,6 +5,6 @@ - **ci.yml**: text-only changes skip; otherwise `cargo test --workspace --locked` on ubuntu-latest with protobuf compiler. OpenAPI-drift check that auto-commits the regenerated `openapi.json` for same-repository PRs. Also runs the AGENTS.md cross-link integrity check (`scripts/check-agents-md.sh`). - **AWS feature build job**: `cargo build/test -p omnigraph-server --features aws` on ubuntu-latest. - **RustFS S3 integration**: spins up RustFS in Docker, runs `s3_storage`, `server_opens_s3_graph_directly_and_serves_snapshot_and_read`, and `local_cli_s3_end_to_end_init_load_read_flow`. -- **release-edge.yml**: on every push to main, retags `edge`, builds Linux/macOS-Intel/macOS-arm64 archives + sha256, publishes a rolling prerelease. -- **release.yml**: on `v*` tags, builds the 3-platform matrix and updates the Homebrew tap (`scripts/update-homebrew-formula.sh`) by pushing the regenerated formula to `ModernRelay/homebrew-tap`. +- **release-edge.yml**: on every push to main, retags `edge`, builds Linux x86_64 / macOS arm64 archives + sha256, publishes a rolling prerelease. +- **release.yml**: on `v*` tags, builds the Linux x86_64 / macOS arm64 release matrix and updates the Homebrew tap (`scripts/update-homebrew-formula.sh`) by pushing the regenerated formula to `ModernRelay/homebrew-tap`. - **package.yml**: manual ECR image build; emits two image tags per commit (``, `-aws`) via CodeBuild. diff --git a/docs/user/deployment.md b/docs/user/deployment.md index 94f79b0..fc5ee08 100644 --- a/docs/user/deployment.md +++ b/docs/user/deployment.md @@ -140,9 +140,9 @@ The server binary ships in two flavors: | **Default** (on-prem / local dev) | `cargo build --release` | Core server, no AWS SDK | | **AWS** | `cargo build --release --features aws` | Adds AWS Secrets Manager backend for bearer tokens | -Release artifacts are published with matching suffixes — -`omnigraph-server--.tar.gz` for the default build and -`omnigraph-server---aws.tar.gz` for the AWS-enabled build. +Tagged release archives contain the default `omnigraph` and +`omnigraph-server` binaries. AWS-enabled server binaries are built from source +with `cargo build --release --features aws -p omnigraph-server` when needed. The AWS build adds ~150 transitive deps and ~30-60s of first-build compile time. Default builds don't pay that cost. diff --git a/docs/user/install.md b/docs/user/install.md index 725961e..ea9fb8c 100644 --- a/docs/user/install.md +++ b/docs/user/install.md @@ -78,7 +78,6 @@ install -m 0755 target/release/omnigraph-server ~/.local/bin/omnigraph-server Tagged releases are expected to publish: - `omnigraph-linux-x86_64.tar.gz` -- `omnigraph-macos-x86_64.tar.gz` - `omnigraph-macos-arm64.tar.gz` Each archive contains both binaries: