docs(readme): document how this repo is versioned - #102
Merged
Conversation
Every repo in the org now pins to a tag here rather than @main (#25), which makes two things load-bearing that were nowhere written down: that consumers pin @<sha> # <version> rather than @<tag>, and that merging to main releases nothing until someone tags. The second already bit: 1.0.0 was tagged before #99 merged, so the consumers pinned to it are still on the old VS Code publish path. A tag that lags main means fixes reach nobody and Renovate has nothing to propose. Signed-off-by: Jimisola Laursen <jimisola@jimisola.com>
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
1 participant
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.
Description
Now that #25 has every repo in the org pinning to a tag here instead of
@main, two things are load-bearing that were written down nowhere:@<sha> # <version>, not@<tag>. A bare tag is mutable, so CodeQL'sactions/unpinned-tagflags it — that rule fired twice this week. The SHA resolves; the comment is what Renovate keys off.mainreleases nothing. Consumers stay on their pinned tag until a new one exists.The second is not hypothetical — it already happened, within hours:
1.0.0ef815eaHaaLeoactionmaindcf985bvsce/ovsxCLIs (#99)reqstool-vscodepins1.0.0, so #99's CLI swap is not in effect and #109'sovsxdependency is currently unused. A tag that lagsmainmeans fixes reach nobody and Renovate has nothing to propose.The section also notes this is deliberately not the
RELEASING.mdflow — that covers the other repos publishing to real registries. Nothing here is published, so a tag is the whole release.Not included
The Contents table is stale beyond the scope of this PR — it still lists
.github/workflows/check-semantic-pr.yml(renamed tocommon-check-semantic-pr.yml), and omitsRELEASING.md, the sixcommon-release-*workflows, and the whole.github/actions/directory. Left alone deliberately rather than half-fixing it; happy to do it as a follow-up.Checklist
git commit -s).Test plan
Documentation only — no workflow or config touched.