Skip to content

docs: install snippets pin 0.1.0-alpha.1, three prereleases behind the current 0.1.0-alpha.4 #99

Description

@OmarAlJarrah

Problem

Every install coordinate/snippet across the docs pins 0.1.0-alpha.1:

  • README.md:42, :56, :68, :148 (Gradle/Maven/version-catalog snippets)
  • site/src/content/docs/guides/installation.mdx:18, :35, :46
  • site/src/pages/index.astro:7
  • site/src/content/docs/guides/versioning-and-stability.mdx:8

The actual current version, per gradle.properties (version=0.1.0-alpha.4) and .release-please-manifest.json, is 0.1.0-alpha.4. release-please rewrites those two files on each release but never touches these hand-maintained doc snippets, so they've drifted three releases behind. Notably, a KURI_VERSION constant already exists specifically to avoid this drift (kuri/build.gradle.kts:43-64, used on the generated landing-page/site build), but the hand-written snippets don't reference it.

Impact

A user copies the install snippet as-is and pins org.dexpace:kuri:0.1.0-alpha.1 in their own build, silently pulling a three-versions-old alpha and missing every fix shipped in alpha.2 through alpha.4 — which directly contradicts the guides' own advice to pin an exact (and presumably current) alpha version.

Suggested fix

Either wire the docs-site snippets to read the version from the same generated KURI_VERSION source used elsewhere, or add a release-please "extra file" hook so the manifest bump also updates these snippets, and fix the README instances similarly since they're outside the site build entirely.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions