Skip to content

docs: bump install version to 0.4.0 and align CI gate#88

Merged
bryantbiggs merged 2 commits into
mainfrom
fix/doc-drift
May 5, 2026
Merged

docs: bump install version to 0.4.0 and align CI gate#88
bryantbiggs merged 2 commits into
mainfrom
fix/doc-drift

Conversation

@bryantbiggs

Copy link
Copy Markdown
Member

Summary

  • Bump documented Helm install version from 0.1.0 to 0.4.0 in README and three docs pages (getting-started, helm, fips); the snippets had drifted across releases.
  • Align the local CI gate command in CLAUDE.md with what `.github/workflows/ci.yml` actually runs (`cargo fmt --all`, `--locked` on clippy and test) so a passing local gate matches CI behavior.
  • Drop a dead reference in `crates/ocync-distribution/CLAUDE.md` to a spec under the gitignored `docs/superpowers/specs/` tree; the feature shipped and per repo convention implemented specs are deleted.

Found via a full-repo accuracy sweep. Code is clean (`cargo fmt && clippy && test && deny check` all pass); these were the only doc/config drift items.

Test plan

  • `cd docs && npm run build` passes (no broken links / frontmatter regressions)
  • `cargo fmt --all -- --check && cargo clippy --workspace --all-targets --locked -- -D warnings && cargo test --workspace --no-run --locked && cargo deny check` passes
  • CI green

Documented install snippets still showed 0.1.0; bump README, getting-started,
helm, and fips pages to match the current 0.4.0 release.

Align the local CI gate command in CLAUDE.md with what .github/workflows/ci.yml
actually runs (cargo fmt --all, --locked on clippy and test) so a passing local
gate matches CI behavior.

Drop dead reference in crates/ocync-distribution/CLAUDE.md to a spec under the
gitignored docs/superpowers/specs/ tree (feature is implemented; per repo
convention, implemented specs are deleted).
Add 4 pre-release-replacements entries so the helm install --version snippets
in README, getting-started, helm pages and the ocync version example output in
fips.md track the workspace version automatically. Updates RELEASING.md step 2
and the manual fallback to reflect the new replacement set, plus aligns the
pre-flight gate command with what CI actually runs (consistent with the
matching update to the root CLAUDE.md).

The regex anchors with ^...$ and uses exactly = 1, so any future drift in
these files (rename, format change, additional match) fails the release fast
before producing a commit or tag, mirroring the helm-docs hook behavior.
@bryantbiggs
bryantbiggs merged commit 0d9ca76 into main May 5, 2026
16 checks passed
@bryantbiggs
bryantbiggs deleted the fix/doc-drift branch May 5, 2026 22:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant