Skip to content

Commit ae76591

Browse files
committed
Add VERSIONING.md
1 parent db86e07 commit ae76591

2 files changed

Lines changed: 39 additions & 0 deletions

File tree

VERSION

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
1.0.0

VERSIONING.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Versioning Policy
2+
3+
BugleOS Cross Toolchain follows Semantic Versioning 2.0.0.
4+
5+
## Version Format
6+
7+
`MAJOR.MINOR.PATCH` stored in the `VERSION` file.
8+
9+
- **MAJOR**: incompatible changes (build outputs, flags, toolchain layout)
10+
- **MINOR**: backward-compatible feature additions
11+
- **PATCH**: backward-compatible bug fixes and reproducibility fixes
12+
13+
## Tags
14+
15+
Release tags follow:
16+
17+
`vMAJOR.MINOR.PATCH`
18+
or
19+
`vMAJOR.MINOR.PATCH-PRERELEASE`
20+
21+
Examples:
22+
- `v1.2.3`
23+
- `v1.2.3-rc.1`
24+
25+
## Release Process
26+
27+
1. Update `VERSION` with the next `MAJOR.MINOR.PATCH`.
28+
2. Create an annotated tag using the `Tag from VERSION` workflow.
29+
3. CI builds artifacts, verifies checksums, and publishes the release.
30+
31+
## Pre-releases
32+
33+
Pre-releases are allowed (e.g., `-rc.1`, `-beta.1`) and are published as
34+
pre-release tags in GitHub.
35+
36+
## Hotfixes
37+
38+
Hotfixes increment **PATCH** and follow the same release process.

0 commit comments

Comments
 (0)