docs: add release process documentation - #92
Merged
Conversation
Document the new automatic versioning workflow with GitVersion. This is the first commit after v1.0.0, which will trigger v1.0.1 tag creation. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
🏗️ PR Added to Squad Triage QueueThis PR has been labeled with Next steps:
|
github-actions
Bot
added
the
squad
Contributor
SummarySummary
CoverageAppHost - 0%
Domain - 87.2%
ServiceDefaults - 0%
Web - 68.7%
|
Contributor
|
There was a problem hiding this comment.
Pull request overview
Adds a top-level RELEASE.md intended to document the repository’s move to GitVersion-driven semantic versioning and CI-based tagging.
Changes:
- Introduces
RELEASE.mddescribing the automatic versioning/tagging flow. - Documents intended versioning rules for
main,dev, and feature branches. - Adds a release checklist and notes about legacy sprint tags.
Comment on lines
+18
to
+20
| 1. Merge feature PR to dev → gets alpha tag | ||
| 2. Merge dev to main → gets release tag (v1.0.X) | ||
| 3. GitHub Actions creates and pushes the tag automatically |
Comment on lines
+8
to
+10
| 1. **Main branch commits** → GitVersion calculates next patch version | ||
| 2. **CI workflow** → Automatically creates and pushes git tag (e.g., `v1.0.1`) | ||
| 3. **GitHub Release** → Create release from the tag (Aragorn's workflow) |
Comment on lines
+8
to
+13
| 1. **Main branch commits** → GitVersion calculates next patch version | ||
| 2. **CI workflow** → Automatically creates and pushes git tag (e.g., `v1.0.1`) | ||
| 3. **GitHub Release** → Create release from the tag (Aragorn's workflow) | ||
|
|
||
| ### Version Scheme | ||
| - **Main branch**: Increments `Patch` (1.0.0 → 1.0.1 → 1.0.2...) |
Comment on lines
+24
to
+26
| - `v1.0.0-sprint1`, `v1.0.0-sprint2`, `v1.0.0-sprint3` are archived | ||
| - `v1.0.0` is the first pure-semver release | ||
| - No manual sprint tags going forward |
Comment on lines
+17
to
+21
| ### Release Checklist | ||
| 1. Merge feature PR to dev → gets alpha tag | ||
| 2. Merge dev to main → gets release tag (v1.0.X) | ||
| 3. GitHub Actions creates and pushes the tag automatically | ||
| 4. (Manual) Create GitHub Release using the tag |
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.
Add RELEASE.md documenting the new automatic versioning workflow.
This commit on main will trigger v1.0.1 tag creation via the CI workflow.