Skip to content

Commit 993f230

Browse files
committed
docs: add release guide (RELEASE.md)
1 parent 915352c commit 993f230

1 file changed

Lines changed: 48 additions & 0 deletions

File tree

RELEASE.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# 🚀 Release Guide für BestNote
2+
3+
Dieses Dokument beschreibt die Schritte zur Veröffentlichung eines neuen Releases.
4+
5+
## 🧪 Vorbereitungen
6+
7+
- [ ] Alle Tests laufen (`npm run test`)
8+
- [ ] `CHANGELOG.md` aktualisiert
9+
- [ ] `package.json` Version angepasst (z. B. `"version": "1.1.0"`)
10+
- [ ] Commit mit `chore(release): bump version to x.y.z`
11+
12+
## 🏷️ Git-Tag erstellen
13+
14+
```bash
15+
git tag -a v1.1.0 -m "Release v1.1.0"
16+
git push origin v1.1.0
17+
```
18+
19+
## 📦 GitHub Release anlegen
20+
21+
```bash
22+
gh release create v1.1.0 \
23+
--title "BestNote v1.1.0 – [Titel]" \
24+
--notes-file CHANGELOG.md \
25+
--latest
26+
```
27+
28+
## 📁 Optional: Release-Assets hochladen
29+
30+
```bash
31+
gh release upload v1.1.0 dist.zip
32+
```
33+
34+
## 📝 Nachbereitung
35+
36+
- [ ] `docs/CHANGELOG.md` verlinken
37+
- [ ] Release auf GitHub als „latest“ markieren (falls gewünscht)
38+
- [ ] `contributing.md` ggf. aktualisieren
39+
40+
---
41+
42+
### 💾 Commit-Vorschlag
43+
44+
```bash
45+
git add RELEASE.md
46+
git commit -m "docs: add release guide (RELEASE.md)"
47+
git push
48+
```

0 commit comments

Comments
 (0)