Skip to content

docs: codify snapshot reference policy#39

Merged
debop merged 1 commit into
mainfrom
docs/release-runbook-snapshot-policy
May 24, 2026
Merged

docs: codify snapshot reference policy#39
debop merged 1 commit into
mainfrom
docs/release-runbook-snapshot-policy

Conversation

@debop
Copy link
Copy Markdown
Contributor

@debop debop commented May 24, 2026

Summary

  • Document the post-release version-line rule: advance baseVersion to the next release version and keep snapshotVersion= empty.
  • Clarify that publish-snapshot.yml injects -PsnapshotVersion=-SNAPSHOT, while release publishing uses baseVersion only.
  • Clarify internal bluetape4k-* reference policy: development branches use matching upstream -SNAPSHOT; release-prep branches remove the suffix only after the upstream release is visible from Maven Central.
  • Add a short lesson for future release-train work.

Verification

  • git diff --check

Notes

This repository uses release.yml as the release publishing workflow name; the policy applies to any future publish-release.yml equivalent as well.

Document the post-release version line rule and the difference between checked-in development versions, workflow-injected snapshot publication, and release-prep dependency references.

Constraint: bluetape4k repositories use baseVersion plus snapshotVersion and publish snapshots through workflow parameters.

Rejected: keep internal bluetape4k references on released versions during development | development consumers need matching upstream snapshots until release prep.

Confidence: high

Scope-risk: narrow

Directive: do not check -SNAPSHOT into snapshotVersion; inject it from publish-snapshot workflows and remove dependency snapshot suffixes only during release prep.

Tested: git diff --check

Not-tested: rendered documentation site
@debop debop added the documentation Improvements or additions to documentation label May 24, 2026
@debop debop self-assigned this May 24, 2026
@debop debop merged commit 92cb51a into main May 24, 2026
2 checks passed
@debop debop deleted the docs/release-runbook-snapshot-policy branch May 24, 2026 02:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant