From 32193ba7e15bc22f02bb344436d97b329c6d4e21 Mon Sep 17 00:00:00 2001 From: Asad Iqbal Date: Wed, 3 Jun 2026 14:25:22 +0500 Subject: [PATCH] docs: refresh README for the v0.1.0-alpha release MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit v0.1.0-alpha is published (pre-release). The README still said "first release pending" / "no tagged release exists yet" and advertised `curl https://install.tracebloc.io | sh` — but that vanity domain isn't wired up, and GitHub's `latest` redirect skips pre-releases, so neither the domain shortcut nor a `latest`-based one-liner can install the alpha. - Status: "first release pending" -> v0.1.0-alpha published (pre-release). - Install: replace the dead install.tracebloc.io commands with the working explicit-tag invocation + a link to the signed release assets; note the domain / `latest` / Homebrew all await the first stable tag. - Roadmap: Phase 5 "awaiting first v* tag" -> alpha published. Docs only; no behavior change. Closes #23 Co-Authored-By: Claude Opus 4.8 --- README.md | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 8e85ebe..da3f27b 100644 --- a/README.md +++ b/README.md @@ -6,11 +6,11 @@ The customer-facing CLI for the tracebloc declarative ingestion path. Wraps the ## Status -**v0.1 — feature-complete on `develop`; first release pending.** Every phase of the [v0.1 roadmap](https://github.com/tracebloc/client/issues/147) (#148–#153) is merged. The binary implements `version`, `completion`, `ingest validate`, `cluster info`, and the full `dataset push` flow — local schema validation, cluster discovery, data staging, submission, and Job watching, end to end. +**v0.1.0-alpha is published** — the first [release](https://github.com/tracebloc/cli/releases/tag/v0.1.0-alpha), a pre-release for early testers, cut from `develop`. Every phase of the [v0.1 roadmap](https://github.com/tracebloc/client/issues/147) (#148–#153) is merged. The binary implements `version`, `completion`, `ingest validate`, `cluster info`, and the full `dataset push` flow — local schema validation, cluster discovery, data staging, submission, and Job watching, end to end. `dataset push` covers **9 of 10 task categories**: `image_classification`, `object_detection`, `keypoint_detection`, `text_classification`, `masked_language_modeling`, `tabular_classification`, `tabular_regression`, `time_series_forecasting`, and `time_to_event_prediction`. `semantic_segmentation` is pending mask-sidecar support upstream ([data-ingestors#136](https://github.com/tracebloc/data-ingestors/issues/136)); `instance_segmentation` is not yet implemented. -No tagged release exists yet — [build from source](#building-from-source) for now. The release pipeline (GitHub Release + install scripts) is wired and fires on the first `v*` tag. (A Homebrew tap is a later follow-up.) +The release pipeline has shipped [`v0.1.0-alpha`](https://github.com/tracebloc/cli/releases/tag/v0.1.0-alpha): cosign-signed binaries for linux/darwin/windows (amd64/arm64), `SHA256SUMS`, and the install scripts. Install it via [Customer experience](#customer-experience) or [build from source](#building-from-source). (The `install.tracebloc.io` shortcut, the `latest` one-liner, and a Homebrew tap all wait for the first **stable** `v*` tag — see below.) The Helm chart remains a sibling interface for the Kubernetes-native workflow: `helm install tracebloc/ingestor --set-file ingestConfig=./ingest.yaml` (see the chart's [README](https://github.com/tracebloc/client/blob/develop/ingestor/README.md)). @@ -43,12 +43,13 @@ The protocol — the v1 schema + the POST endpoint — is the stable point. Ever ## Customer experience -> The install commands below light up once `v0.1.0` is tagged and the release pipeline publishes the artifacts. Until then, [build from source](#building-from-source). +> `v0.1.0-alpha` is a **pre-release**, so the `install.tracebloc.io` shortcut isn't wired up yet and GitHub's `latest` skips pre-releases. Install the alpha by explicit tag (below), or [build from source](#building-from-source). ```bash -# Install once (after v0.1.0 is released) -curl -fsSL https://install.tracebloc.io | sh # Linux/macOS -irm https://install.tracebloc.io/install.ps1 | iex # Windows +# Install the alpha — pins the pre-release tag (Linux/macOS) +curl -fsSL https://github.com/tracebloc/cli/releases/download/v0.1.0-alpha/install.sh \ + | sh -s -- --version v0.1.0-alpha +# Windows + manual/signed downloads: https://github.com/tracebloc/cli/releases/tag/v0.1.0-alpha # Per dataset tracebloc dataset push ./my-data \ @@ -100,7 +101,7 @@ All v0.1 phases are merged: | 2 | [#150](https://github.com/tracebloc/client/issues/150) | Cluster discovery + ingestor SA token via TokenRequest | ✅ | | 3 | [#151](https://github.com/tracebloc/client/issues/151) | Stage data into the shared PVC via ephemeral Pod | ✅ | | 4 | [#152](https://github.com/tracebloc/client/issues/152) | Submit to jobs-manager + watch ingestor Job + summary | ✅ | -| 5 | [#153](https://github.com/tracebloc/client/issues/153) | GitHub Releases + install.sh distribution (Homebrew tap deferred) | ✅ (awaiting first `v*` tag) | +| 5 | [#153](https://github.com/tracebloc/client/issues/153) | GitHub Releases + install.sh distribution (Homebrew tap deferred) | ✅ — [`v0.1.0-alpha`](https://github.com/tracebloc/cli/releases/tag/v0.1.0-alpha) published (pre-release) | Beyond the original phases, `dataset push` was widened from image-classification-only to 9 of 10 modalities, and the test suite gained unit-coverage wins plus a kind-based integration harness for the real-I/O seams.