From 7bc6a79d1486f6f97ef32fe540f585893d9a9b22 Mon Sep 17 00:00:00 2001 From: Derek Date: Sat, 14 Nov 2026 08:17:16 +1100 Subject: [PATCH] docs(versions): use placeholders where docs copied versions The publishing page used v1.6.13 and contract 2.14.3 as examples. Both go stale with each release. The page uses v and placeholders. The clickhouse-ext snippet and the gRPC page point at Cargo.toml for crate versions. Historical sections keep the versions they record. --- docs/clickhouse/clickhouse-ext.md | 6 +++--- docs/deployment/publishing.md | 16 ++++++++-------- docs/transport/grpc.md | 2 +- 3 files changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/clickhouse/clickhouse-ext.md b/docs/clickhouse/clickhouse-ext.md index d4bda974..52c55ba8 100644 --- a/docs/clickhouse/clickhouse-ext.md +++ b/docs/clickhouse/clickhouse-ext.md @@ -37,11 +37,11 @@ The coercions a source value gets on the way: a zoned timestamp lands at the ins - An encoder refusal (`EncodingError` naming its column) is the payload's, and goes to salvage. - A column type the crate cannot encode is a loader gap, so the rows are held. -Both client crates come from crates.io, with no `[patch]` and no git source: +Both client crates come from crates.io, with no `[patch]` and no git source. `Cargo.toml` carries the version ranges: ```toml -clickhouse = { version = ">=0.15.3, <0.16", features = ["lz4", "time", "rustls-tls", "rustls-tls-native-roots", "inserter"] } -dfe-clickhouse = { version = ">=0.1.9, <0.2", default-features = false, features = ["ext", "tls", "dynamic"] } +clickhouse = { version = "...", features = ["lz4", "time", "rustls-tls", "rustls-tls-native-roots", "inserter"] } +dfe-clickhouse = { version = "...", default-features = false, features = ["ext", "tls", "dynamic"] } ``` From `dfe-clickhouse` the loader also takes `ServerException::parse` (`ext`), which reads the code and message out of the `Code: N. DB::Exception: ...` text the HTTP client returns as `Error::BadResponse`, and `TcpClient` with its rustls trust (`tls`, which implies `tcp`) for `clickhouse.protocol: native`. `src/clickhouse/error.rs` classifies every insert rejection by the server's code and keeps at most 1 MiB of any error text. diff --git a/docs/deployment/publishing.md b/docs/deployment/publishing.md index 58919ff7..25531fc4 100644 --- a/docs/deployment/publishing.md +++ b/docs/deployment/publishing.md @@ -41,7 +41,7 @@ release: helm: enabled: true contract: emit - library: "2.14.3" + library: "" container: enabled: true dockerfile: Dockerfile @@ -56,13 +56,13 @@ The `Dockerfile` is generated from the app's deployment contract by scalo and co ## Tags generated -For a stable release `v1.6.13`: +For a stable release `v`: -- `ghcr.io/hyperi-io/dfe-loader:v1.6.13` +- `ghcr.io/hyperi-io/dfe-loader:v` - `ghcr.io/hyperi-io/dfe-loader:latest` - `ghcr.io/hyperi-io/dfe-loader:sha-` -A prerelease (e.g. `v1.6.13-rc.1`) gets its version tag and `sha-` +A prerelease (e.g. `v-rc.1`) gets its version tag and `sha-` only. It never moves `latest`. ## Verification @@ -70,9 +70,9 @@ only. It never moves `latest`. After a release: ```bash -docker pull ghcr.io/hyperi-io/dfe-loader:v1.6.13 -docker run --rm ghcr.io/hyperi-io/dfe-loader:v1.6.13 --help -docker manifest inspect ghcr.io/hyperi-io/dfe-loader:v1.6.13 +docker pull ghcr.io/hyperi-io/dfe-loader:v +docker run --rm ghcr.io/hyperi-io/dfe-loader:v --help +docker manifest inspect ghcr.io/hyperi-io/dfe-loader:v ``` ## Consumer usage @@ -94,7 +94,7 @@ services: ```yaml containers: - name: dfe-loader - image: ghcr.io/hyperi-io/dfe-loader:v1.6.13 + image: ghcr.io/hyperi-io/dfe-loader:v ports: - containerPort: 9090 ``` diff --git a/docs/transport/grpc.md b/docs/transport/grpc.md index f0d41c91..c70ec647 100644 --- a/docs/transport/grpc.md +++ b/docs/transport/grpc.md @@ -27,7 +27,7 @@ dfe-archiver) a server that receives event batches, and gives dfe-receiver (and transformers) a client that pushes batches directly -- a Kafka-less path when you want one. -- **Wire protocol:** gRPC (Protobuf over HTTP/2) via `tonic` 0.14.x. +- **Wire protocol:** gRPC (Protobuf over HTTP/2) via `tonic`, at the version scalo-rs's `Cargo.toml` pins. - **Scope:** scalo transport module + dfe-loader, dfe-archiver, dfe-receiver. - **Feature flag:** `transport-grpc` (optional `tonic` + `prost` deps).