mirror of
https://git.sanhost.net/sanasol/hytale-f2p.git
synced 2026-02-26 06:41:47 -03:00
Add semantic versioning policy documentation - numerical versions only
This commit is contained in:
18
.github/README1.md
vendored
18
.github/README1.md
vendored
@@ -22,13 +22,25 @@ All builds run in parallel:
|
||||
|
||||
### Creating a Release
|
||||
|
||||
1. Update version in `package.json`
|
||||
**⚠️ IMPORTANT: Semantic Versioning Required**
|
||||
|
||||
This project uses **strict semantic versioning with numerical versions only**:
|
||||
- ✅ **Valid**: `2.0.1`, `2.0.11`, `2.1.0`, `3.0.0`
|
||||
- ❌ **Invalid**: `2.0.2b`, `2.0.2a`, `2.0.1-beta`
|
||||
|
||||
**Format**: `MAJOR.MINOR.PATCH` (e.g., `2.0.11`)
|
||||
|
||||
The auto-update system requires semantic versioning for proper version comparison. Letter suffixes are not supported.
|
||||
|
||||
**Steps:**
|
||||
|
||||
1. Update version in `package.json` (use numerical format only, e.g., `2.0.11`)
|
||||
2. Commit and push to `main`
|
||||
3. Create and push a version tag:
|
||||
|
||||
```bash
|
||||
git tag v2.0.1
|
||||
git push origin v2.0.1
|
||||
git tag v2.0.11
|
||||
git push origin v2.0.11
|
||||
```
|
||||
|
||||
The workflow will:
|
||||
|
||||
19
README.md
19
README.md
@@ -76,6 +76,25 @@ See [BUILD.md](BUILD.md) for comprehensive build instructions.
|
||||
|
||||
---
|
||||
|
||||
## 📌 Versioning Policy
|
||||
|
||||
**⚠️ Important: Semantic Versioning Required**
|
||||
|
||||
This project follows **strict semantic versioning** with **numerical versions only**:
|
||||
|
||||
- ✅ **Valid**: `2.0.1`, `2.0.11`, `2.1.0`, `3.0.0`
|
||||
- ❌ **Invalid**: `2.0.2b`, `2.0.2a`, `2.0.1-beta`, `v2.0.2b`
|
||||
|
||||
**Format**: `MAJOR.MINOR.PATCH` (e.g., `2.0.11`)
|
||||
|
||||
- **MAJOR**: Breaking changes
|
||||
- **MINOR**: New features (backward compatible)
|
||||
- **PATCH**: Bug fixes (backward compatible)
|
||||
|
||||
**Why?** The auto-update system requires semantic versioning for proper version comparison. Letter suffixes (like `2.0.2b`) are not supported and will cause update detection issues.
|
||||
|
||||
---
|
||||
|
||||
## 📋 Changelog
|
||||
|
||||
### 🆕 v2.0.2b *(Minor Update: Performance & Utilities)*
|
||||
|
||||
Reference in New Issue
Block a user