Skip to content
This repository was archived by the owner on Nov 16, 2025. It is now read-only.

Commit 0e23ded

Browse files
committed
docs: clarify version configuration for releases
Add explicit instructions about setting MARKETING_VERSION with pre-release suffixes in version.xcconfig to prevent double suffix issues like 'v2.0.0-beta.3-beta.3'
1 parent 7ac8b3b commit 0e23ded

File tree

1 file changed

+20
-5
lines changed

1 file changed

+20
-5
lines changed

docs/RELEASE.md

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -32,18 +32,33 @@ Before creating any release, ensure the CHANGELOG.md file contains a proper sect
3232

3333
**CRITICAL**: The appcast generation relies on the local CHANGELOG.md file, NOT the GitHub release description. The changelog must be added to CHANGELOG.md BEFORE running the release script.
3434

35-
### Step 3: Create the Release
35+
### Step 3: Update Version Configuration
36+
Before creating a release, update the version in `VibeMeter/version.xcconfig`:
37+
38+
```
39+
MARKETING_VERSION = 2.0.0 # For stable releases
40+
MARKETING_VERSION = 2.0.0-beta.3 # For pre-releases
41+
CURRENT_PROJECT_VERSION = 203 # Must increment for each release
42+
```
43+
44+
**CRITICAL**:
45+
- For pre-releases, include the suffix in MARKETING_VERSION (e.g., "2.0.0-beta.3")
46+
- For stable releases, use only the base version (e.g., "2.0.0")
47+
- The release script will detect and use the version as configured
48+
- Always increment CURRENT_PROJECT_VERSION (build number)
49+
50+
### Step 4: Create the Release
3651
```bash
3752
# For stable releases:
3853
./scripts/release.sh stable
3954

4055
# For pre-releases (beta, alpha, rc):
41-
./scripts/release.sh beta 1 # Creates version-beta.1
42-
./scripts/release.sh alpha 2 # Creates version-alpha.2
43-
./scripts/release.sh rc 1 # Creates version-rc.1
56+
./scripts/release.sh beta 3 # Expects version.xcconfig to have "2.0.0-beta.3"
57+
./scripts/release.sh alpha 2 # Expects version.xcconfig to have "2.0.0-alpha.2"
58+
./scripts/release.sh rc 1 # Expects version.xcconfig to have "2.0.0-rc.1"
4459
```
4560

46-
**IMPORTANT**: The release script does NOT automatically increment build numbers. You must manually update the build number in Project.swift before running the script, or it will fail the pre-flight check.
61+
**IMPORTANT**: The release script validates that the version in version.xcconfig matches the expected format for the release type.
4762

4863
The script will:
4964
1. Validate build number is unique and incrementing

0 commit comments

Comments
 (0)