docs: codify snapshot reference policy#39
Merged
Conversation
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
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
baseVersionto the next release version and keepsnapshotVersion=empty.publish-snapshot.ymlinjects-PsnapshotVersion=-SNAPSHOT, while release publishing usesbaseVersiononly.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.Verification
git diff --checkNotes
This repository uses
release.ymlas the release publishing workflow name; the policy applies to any futurepublish-release.ymlequivalent as well.