docs: reference the 0.22.0 train (core 0.22.0, drivers/sidecar 0.3.1, installer pin v0.22.0) - #272
Merged
Merged
Conversation
…, installer pin v0.22.0
Post-release documentation sweep for the 0.22.0 train (core 0.22.0 · extensions
0.3.1 · arrow 0.3.1 · jdbc 0.3.1 · repl bundle 0.22.0 · helm chart 0.3.7 /
appVersion 0.3.1). Companion sweep in softclient4es-web.
EVERY version written here was verified published on JFrog BEFORE it was
written, not after: the four per-ES jdbc/adbc/arrow-flight-sql jars at 0.3.1
(12 × 200), and softclient4es-jdbc-driver_2.13 / community-extensions_2.13 /
arrow-extensions_2.13 at 0.3.1 + softclient4es8-java-client_2.13 at 0.22.0. A
version with no artefact fails SILENTLY here — an installer falls back to the
plain jar, which carries no arrow extensions and therefore no cross-index JOIN,
so the docs would demonstrate the path that loses the headline feature.
Swept: README (driver table + Maven/Gradle/sbt coordinates + the Scala
dependency block), documentation/client/{jdbc,adbc_driver,arrow_flight_sql}.md
(jar tables + coordinates), documentation/client/repl.md (install examples),
documentation/client/download_analytics.md (the example artefact version),
install.ps1 (help example), install.cmd (help example + the pinned installer).
install.cmd: PS1_REF v0.21.0 -> v0.22.0 AND PS1_SHA256 recomputed together, per
the RELEASE RITUAL comment above them — a bumped tag with a stale hash is a hard
failure for every install.cmd-only user. The new hash
(6a31198e6817...de0ae5c4) is the SHA-256 of install.ps1 AT TAG v0.22.0. The
method was validated first by recomputing v0.21.0's hash, which reproduced the
currently-pinned e1275bd2...03912ae exactly. The file is CRLF by .gitattributes
(-text): edited in BINARY mode, and the CRLF count is 165 before and after with
zero bare LF — a text-mode rewrite silently converts the whole file and shows up
as a 165-line diff.
NOT bumped, deliberately — these date a feature's availability, they do not
track the current version. Bumping them would tell a 0.21.0 user they lack a
feature they have:
- scroll.md:51,147,319 — sliced PIT "(0.21.0+)" / "Default since 0.21.0"
- common_principles.md:491,538 — "Paged row extraction … 0.21.0+"
- repl.md:54 — Windows Java bootstrap "Since 0.20.4"
Note the `X+` spelling does NOT match a /since|before/ guard; the guard has to
catch the family, not one wording.
The captured `--list-versions` block in repl.md GAINED a line rather than being
renamed: the sweep's first pass rewrote "• 0.21.0" to "• 0.22.0", which would
have told users 0.21.0 no longer exists and left "Total: 5" stale. It is now
re-captured for real — `bash install.sh --list-versions --es-version 8`, ANSI
stripped — and the committed block is byte-identical to the live output
(0.20.1 … 0.21.0, 0.22.0; Total: 6).
fupelaqu
marked this pull request as ready for review
September 3, 2026 21:15
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Post-release doc sweep — 0.22.0 train
Points every version-bearing surface at the just-released train: core 0.22.0 · extensions 0.3.1 · arrow 0.3.1 · jdbc 0.3.1 · repl bundle 0.22.0. Companion sweep: softclient4es-web#47.
Verified published BEFORE writing, not after
Every version this PR writes was probed on JFrog first — the 12 per-ES
jdbc-driver/adbc-driver/arrow-flight-sqljars at 0.3.1, plussoftclient4es-jdbc-driver_2.13,community-extensions_2.13,arrow-extensions_2.13at 0.3.1 andsoftclient4es8-java-client_2.13at 0.22.0. All 200.The failure this guards against is silent: a version with no
-allbundle makes the installer fall back to the plain artifact, which carries no arrow extensions and therefore no cross-index JOIN — the docs would demonstrate the path that loses the headline feature.Swept
README.md(driver table, Maven/Gradle/sbt coordinates, the Scala dependency block) ·documentation/client/{jdbc,adbc_driver,arrow_flight_sql}.md(jar tables + coordinates) ·documentation/client/repl.md(install examples) ·documentation/client/download_analytics.md·install.ps1(help example) ·install.cmd.install.cmd— the release ritual, both halvesPS1_REFv0.21.0→v0.22.0andPS1_SHA256recomputed together, exactly as the RELEASE RITUAL comment above them requires: a bumped tag with a stale hash is a hard failure for everyinstall.cmd-only user.The new hash is the SHA-256 of
install.ps1at tag v0.22.0. The method was validated first by recomputing v0.21.0's hash, which reproduced the currently-pinnede1275bd2…03912aeexactly — so the new value is right by the same procedure, not by assertion.The file is CRLF by
.gitattributes(-text). My first attempt rewrote it in text mode and silently converted all 165 line endings, showing up as a whole-file diff. Redone in binary: CRLF count 165 before and after, zero bare LF, and the diff is exactly 3 lines.The
--list-versionscapture GAINED a linerepl.md's captured installer output is a quoted product output, and the sweep's first pass renamed• 0.21.0→• 0.22.0— which would have told users 0.21.0 no longer exists while leavingTotal: 5stale.It is now re-captured for real (
bash install.sh --list-versions --es-version 8, ANSI stripped) and the committed block is byte-identical to the live output:0.20.1 … 0.21.0, 0.22.0,Total: 6. Verified against the artefact, not reasoned about.Deliberately NOT bumped — these date a feature, they don't track the current version
scroll.md(0.21.0+)/ "Default since 0.21.0"common_principles.md0.21.0+"repl.md0.20.4"Bumping any of these tells a 0.21.0 user they lack a feature they have. Worth noting for the next sweep: the
X+spelling does not match a/since|before/guard — the guard has to catch the family, not one wording. These were caught by reading the survey, not by the regex.Verification
git diff | grep '^+' | awk '{n=gsub(/"/,...)}') — clean; a wrong capture group in a scripted sweep silently eats a closing quote.git grepfor stragglers across all tracked files (excluding blogs/issues/bmad): zero remaining0.21.0/0.3.0artefact references.--list-versionsblock diffed against live output: identical.🤖 Generated with Claude Code