Skip to content

Commit 9d13db5

Browse files
author
techartdev
committed
docs: add release procedure to AGENTS.md
1 parent 94ac449 commit 9d13db5

1 file changed

Lines changed: 34 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,40 @@ Implement SCP2P from `SPECIFICATION.md` in milestone-oriented increments, priori
3333

3434
If any check cannot run due to environment limitations, explain exactly why in the final report.
3535

36+
## Release procedure
37+
When bumping the version and publishing a release:
38+
39+
1. **Bump versions** using the existing script (never edit version numbers manually):
40+
```powershell
41+
.\scripts\bump-version.ps1 -Version X.Y.Z
42+
```
43+
This updates: workspace `Cargo.toml`, all `scp2p-core` dep pins, `tauri.conf.json`, `package.json`, and `package-lock.json`.
44+
45+
2. **Build & test** before committing:
46+
```powershell
47+
cd app; npm run build; cd ..
48+
cargo test --workspace
49+
cargo clippy --workspace --all-targets -- -D warnings
50+
```
51+
52+
3. **Commit** the version bump.
53+
54+
4. **Create and push 3 annotated tags** (all three are required — the install scripts and CI depend on the tag prefixes):
55+
| Tag pattern | Purpose |
56+
|---------------------|------------------------------------------|
57+
| `vX.Y.Z` | Core / CLI release (install.sh default) |
58+
| `relay-vX.Y.Z` | Relay binary release |
59+
| `desktop-vX.Y.Z` | Desktop app release |
60+
61+
```powershell
62+
git tag -a vX.Y.Z -m "vX.Y.Z: <summary>"
63+
git tag -a relay-vX.Y.Z -m "relay-vX.Y.Z"
64+
git tag -a desktop-vX.Y.Z -m "desktop-vX.Y.Z"
65+
git push origin main vX.Y.Z relay-vX.Y.Z desktop-vX.Y.Z
66+
```
67+
68+
5. **Never** create a custom/placeholder SVG logo — use `assets/icon.svg` directly (copy to `app/public/` if needed for the frontend).
69+
3670
## Skills
3771
A skill is a set of local instructions to follow that is stored in a `SKILL.md` file. Below is the list of skills that can be used. Each entry includes a name, description, and file path so you can open the source for full instructions when using a specific skill.
3872

0 commit comments

Comments
 (0)