Skip to content

docs: align current release pins with v2.1.0 - #557

Merged
codeforester merged 1 commit into
mainfrom
documentation/552-20261007-stale-v2-pins
Oct 7, 2026
Merged

codeforester merged 1 commit into
mainfrom
documentation/552-20261007-stale-v2-pins

Conversation

@codeforester

Copy link
Copy Markdown
Collaborator

Summary

  • align README, versioning policy, and v2 quickstart with the published v2.1.0 commit
  • correct annotated-tag wording and process-module guidance
  • make the README current-release pin a tested tag/commit contract

Validation

  • git diff --check
  • bash -n tests/docs-contract.sh
  • tests/docs-contract.sh

Fixes #552

@codeforester
codeforester merged commit fe005c0 into main Oct 7, 2026
11 checks passed
@codeforester
codeforester deleted the documentation/552-20261007-stale-v2-pins branch October 7, 2026 10:04
@codeforester

Copy link
Copy Markdown
Collaborator Author

Review at the current head: the pins, commit (36fec50, verified against the v2.1.0 tag), "annotated" wording, quickstart note, and the release-process step are all correct, and CI is green. Ready to merge. One non-blocking note:

  • The new check in tests/docs-contract.sh resolves the release tag with git rev-parse --verify "${readme_current_release}^{commit}", so it fails in a checkout that has no tags (for example a shallow clone or a source tarball). CI passes today, so the hosted checkout fetches tags. Consider skipping that last comparison with a clear message when the tag is absent, so contributors on tag-less clones are not blocked.

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.

docs: fix stale v2.0.0 pins and the quickstart's process-module guidance for the v2.1.0 line

1 participant