Skip to content

Commit d1f3ff8

Browse files
gajopclaude
andcommitted
Add release workflow docs
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
1 parent c1925ca commit d1f3ff8

1 file changed

Lines changed: 28 additions & 0 deletions

File tree

docs/releasing.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Releasing SpringBoard
2+
3+
The `SpringBoard release` workflow produces four files:
4+
5+
```text
6+
SpringBoard-Core-<version>-linux-x86_64.sdz
7+
SpringBoard-Core-<version>-windows-x86_64.sdz
8+
SpringBoard-<version>-linux-x86_64.tar.gz
9+
SpringBoard-<version>-windows-x86_64.zip
10+
```
11+
12+
There are two `.sdz` files as SpringBoard Core itself uses Rust and builds different native binaries for each system.
13+
14+
The `.tar.gz` and `.zip` files are complete applications. They contain the engine, editor, settings, start script, and one executable named `SpringBoard` or `SpringBoard.exe`.
15+
16+
## Workflow inputs
17+
18+
- The compatible engine repository and release are committed in `build/distribution.json`.
19+
- The Actions branch selector chooses the SpringBoard source to package.
20+
- `publish`: off produces workflow artifacts only; on creates the tag and GitHub Release.
21+
22+
## Versions
23+
24+
- `stable`: `1.0.0`
25+
- `prerelease`: `1.0.0-beta.1`
26+
- `nightly`: generated as `YYYY-MM-DD-<short-sha>`
27+
28+
Existing tags and releases are never overwritten.

0 commit comments

Comments
 (0)