Skip to content

Document git-tag/release versioning in README#89

Closed
JesperSchulz wants to merge 1 commit into
mainfrom
jesperschulz-docs-versioning
Closed

Document git-tag/release versioning in README#89
JesperSchulz wants to merge 1 commit into
mainfrom
jesperschulz-docs-versioning

Conversation

@JesperSchulz

Copy link
Copy Markdown
Contributor

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 track main with 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.

  • Semver vMAJOR.MINOR.PATCH, with rough guidance on what bumps what (MAJOR for consumer-facing contract breaks, MINOR for new knowledge/skills, PATCH for fixes).
  • How consumers pin a release by targeting refs/tags/vX.Y.Z instead of main, noting that references[] already carries the commit sha for exact provenance.
  • A three-step release checklist (bump the two JSON files, tag, publish).

Docs-only change; no schema, tooling, or CI changes.

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>
@JesperSchulz

Copy link
Copy Markdown
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.

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