Document git-tag/release versioning in README#89
Closed
JesperSchulz wants to merge 1 commit into
Closed
Conversation
Add a Versioning section describing how BCQuality is versioned with git tags and GitHub Releases, what constitutes MAJOR/MINOR/PATCH bumps, how consumers pin a release ref, and how to cut one. No new tooling or schema changes. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Contributor
Author
|
Closing in favor of #88, which introduces the actual versioning mechanism. #88 uses a single monotonic integer (VERSION + manual release workflow) to satisfy a concrete downstream requirement: the BC-ALAgents review engine embeds the BCQuality version as the 3rd segment of its own tag and needs a stable integer. That constraint should drive the scheme, so this docs-only semver PR would document a model the repo won't actually use. Happy to follow up with a README section matching #88's scheme once it lands. |
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.
Why
BCQuality is consumed at a URL and currently has no documented way to version releases or for orchestrators to pin one. The only version signal lives in
plugin.json/marketplace.json(0.1.0), and consumers trackmainwith no stable ref to bind to.What
Adds a short Versioning section to the README that formalizes the simplest possible scheme: git tags and GitHub Releases, no new machinery.
vMAJOR.MINOR.PATCH, with rough guidance on what bumps what (MAJOR for consumer-facing contract breaks, MINOR for new knowledge/skills, PATCH for fixes).refs/tags/vX.Y.Zinstead ofmain, noting thatreferences[]already carries the commitshafor exact provenance.Docs-only change; no schema, tooling, or CI changes.