docs: bump README install snippets to the current release version#151
Closed
OmarAlJarrah wants to merge 1 commit into
Closed
docs: bump README install snippets to the current release version#151OmarAlJarrah wants to merge 1 commit into
OmarAlJarrah wants to merge 1 commit into
Conversation
The README's Maven Central coordinate table, Gradle and Maven install snippets, the Kuri.VERSION example, and the versioning-and-stability blurb all still pinned 0.1.0-alpha.1, three prereleases behind the actual current 0.1.0-alpha.4 in gradle.properties. Anyone who copy-pasted the install snippet as-is would pin a stale alpha and miss every fix since. These are hand-maintained literals rather than generated from the KURI_VERSION constant in kuri/build.gradle.kts: the Gradle/Maven snippets live inside fenced code blocks meant to be copied verbatim, so wiring them through a release-please extra-files marker would leave the marker comments visible in the copied snippet. Hand-fixing on each release, as this commit does, stays the simplest correct option for README.md specifically. Part of #99
Member
Author
|
Superseded by #157, which switches the project to a stable |
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.
Summary
Kuri.VERSIONexample, and the versioning-and-stability blurb all still pinned0.1.0-alpha.1— three prereleases behind the actual current0.1.0-alpha.4(pergradle.properties/.release-please-manifest.json). Anyone copy-pasting the install snippet as-is would pin a stale alpha and silently miss every fix shipped since.README.mdto0.1.0-alpha.4.Scope note
The issue also lists version pins in
site/src/content/docs/guides/installation.mdx,site/src/pages/index.astro, andsite/src/content/docs/guides/versioning-and-stability.mdx. None of those files exist onmainyet — they're part of the still-open docs-site PR (#81) and aren't reachable from amain-based branch. That PR should pick up the same fix before or as part of merging; recommend wiring those specifically to the existingKURI_VERSIONconstant (kuri/build.gradle.kts:43-64) since the Astro/MDX build already has a code path that can inject a real generated value there, unlike plain README markdown.For
README.mditself, I looked at wiring the version through a release-pleaseextra-filesmarker (the waygradle.propertiesalready does) instead of hand-fixing it, but three of the five occurrences sit inside fenced Gradle/Maven/Java code blocks meant to be copied verbatim — thex-release-please-start-version/-endHTML-comment markers would render literally inside those copied snippets. Hand-fixing README on each release, as this PR does, stays the correct approach for that file; the site-side snippets don't have this constraint once #81 lands.Test plan
0.1.0-alpha.4is the actual current released version viagradle.properties,.release-please-manifest.json, and the latestCHANGELOG.mdentry.grep -n "0.1.0-alpha" README.mdconfirms no stale0.1.0-alpha.1references remain.Part of #99 — the site-side portion needs #81 to merge first; filing/tracking that as follow-up rather than closing #99 outright here.