Skip to content

Commit d759086

Browse files
NetdocsCopilot
andcommitted
docs(versioning): align moving-tag table with actual CI
The Moving tags table listed stable/dev/edge tags that CI never publishes. Rewrite it to match what the workflows actually produce: container :latest and :main both track the tip of main (bleeding edge), releases are immutable :vX.Y.Z / :sha-<commit>, and the v1 git alias serves the Action. Drop the redundant dev tag and the non-existent stable/edge tags, and fix the release checklist to describe the real release + v1-alias steps. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent 92a1c6d commit d759086

1 file changed

Lines changed: 14 additions & 11 deletions

File tree

docs-site/docs/development/versioning.md

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -17,24 +17,27 @@ a `1.x` package range) so a future major can't surprise you.
1717

1818
## Moving tags
1919

20-
In addition to immutable `vX.Y.Z` release tags, these convenience tags move over time:
20+
Every release gets an immutable `vX.Y.Z` git tag, and every image build gets an immutable
21+
`:sha-<commit>` tag. The only tags that **move** are:
2122

22-
| Tag | Points at | Stability |
23-
| --- | --- | --- |
24-
| `latest` / `stable` | The most recent stable release. | Safe default. |
25-
| `dev` | The latest build off `main`. | Usually fine, not release-tested. |
26-
| `main` / `unstable` | The tip of `main` — every merged PR. | May be unstable. |
23+
| Tag | Where | Points at | Stability |
24+
| --- | --- | --- | --- |
25+
| `latest` / `main` | container image | The latest build of `main` — every merged PR. | Bleeding edge, not release-tested. |
26+
| `v1` | git tag (Action ref) | The newest `1.x` release, used by `XtremeOwnage/Netdocs@v1`. | Tracks the current major. |
27+
28+
There is no separate `stable`, `dev`, or `edge` tag. `latest` and `main` are the same
29+
bleeding-edge image today, and a specific release is only reachable by its exact version.
2730

28-
For containers this maps to image tags (`ghcr.io/xtremeownage/netdocs:1`,
29-
`:1.2.3`, `:latest`, `:dev`). For a pinned, reproducible build, always use the full
30-
`vX.Y.Z` / `:1.2.3` form.
31+
For a pinned, reproducible build, use the full `vX.Y.Z` git tag, or the `:vX.Y.Z` / `:sha-<commit>`
32+
image tag.
3133

3234
## Release checklist
3335

3436
1. Ensure `main` is green (build + tests + `dotnet format --verify-no-changes`).
3537
2. Update the changelog / release notes.
36-
3. Tag `vX.Y.Z` and push the tag — CI publishes artifacts and moves `latest`/`stable`.
37-
4. `dev` continues to track `main`.
38+
3. Tag `vX.Y.Z` and push the tag — CI publishes the release binaries/packages and the
39+
`:vX.Y.Z` container image.
40+
4. Move the `v1` alias tag onto the new release so `XtremeOwnage/Netdocs@v1` picks it up.
3841

3942
## Suggestions welcome
4043

0 commit comments

Comments
 (0)