Skip to content

Commit bf35205

Browse files
committed
Website/release: add section for versioning
1 parent 06a7301 commit bf35205

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

website/docs/appendix/release-process.mdx

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -149,6 +149,33 @@ _Updates will be posted in this thread_
149149

150150
### 1. Create Release Branch (for major/minor releases)
151151

152+
<!-- prettier-ignore-start -->
153+
154+
:::info Release Branch Naming Convention
155+
156+
Release branches **must** follow the format `release/vX.Y.Z` where:
157+
158+
- The version **must** start with a lowercase `v`
159+
- X, Y, and Z are version numbers following semantic versioning (all three
160+
components required)
161+
162+
**Valid examples:**
163+
164+
- `release/v1.5.0`
165+
- `release/v1.2.3`
166+
- `release/v2.0.0`
167+
168+
**Invalid examples:**
169+
170+
- `release/1.5.0` (missing 'v' prefix)
171+
- `release/v1.5` (missing patch version)
172+
- `release/V1.5.0` (uppercase 'V')
173+
174+
This naming convention is enforced by CI checks. Any push to a branch starting
175+
with `release/` that doesn't follow this format will fail validation. :::
176+
177+
<!-- prettier-ignore-stop -->
178+
152179
```bash
153180
# Create release branch from develop
154181
git checkout develop

0 commit comments

Comments
 (0)