Skip to content

Commit a7d74a2

Browse files
committed
Simplify release guide and add changelog example
1 parent 567889c commit a7d74a2

1 file changed

Lines changed: 29 additions & 0 deletions

File tree

RELEASING.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Releasing Spaceman
2+
3+
Use these steps for a normal release.
4+
5+
## Release steps
6+
7+
1. Choose a semantic version `X.Y.Z`.
8+
2. Update `MARKETING_VERSION` and `CURRENT_PROJECT_VERSION` in Xcode to `X.Y.Z`.
9+
3. Update `CHANGELOG.md` with a new section for this version.
10+
4. Merge to `main`.
11+
5. Tag that `main` commit as `vX.Y.Z` and push the tag.
12+
6. The Release workflow will build, sign, generate appcast entries, and publish assets to GitHub Releases.
13+
14+
### Example changelog edit
15+
16+
```md
17+
## [1.1.0] - 2026-02-06
18+
19+
### Added
20+
- Added automatic update publishing to GitHub Releases.
21+
22+
### Changed
23+
- Updated Sparkle integration and release automation scripts.
24+
```
25+
26+
The heading version must match the app version and tag:
27+
- `MARKETING_VERSION = 1.1.0`
28+
- `CURRENT_PROJECT_VERSION = 1.1.0`
29+
- Git tag: `v1.1.0`

0 commit comments

Comments
 (0)