- Shell 100%
| test | ||
| .gitignore | ||
| CHANGELOG.md | ||
| CLAUDE.md | ||
| cliff.toml | ||
| LICENSE | ||
| pemmikan.md | ||
| README.md | ||
| release.sh | ||
release
git push mit Unterschrift — weil
v1.0.0kein Zufall ist 🖊️
git-cliff Release-Helper für alle holm.tools-Projekte. Ermittelt die nächste Semver-Version, schreibt CHANGELOG.md, erstellt einen signierten Tag und legt den Forgejo-Release an.
Aufruf
release [--yes] [--no-version-bump] [--rc | --final] [--bump <major|minor|patch>] [--local | --publish | --abort]
release -h
--yes überspringt die Bestätigungsabfrage (für non-interaktive Nutzung).
--no-version-bump lässt VERSION=-Zeilen im Repo-Root unangetastet.
Erst testen, dann veröffentlichen
| Aufruf | Wirkung |
|---|---|
release |
lokal releasen und sofort veröffentlichen (ein Lauf, wie bisher) |
release --local |
CHANGELOG, Release-Commit, signierter Tag — nur lokal, kein Push |
release --publish |
unveröffentlichten Tag an HEAD veröffentlichen: Branch + Tag per git push --atomic, Forgejo-Release |
release --abort |
unveröffentlichten Release zurücknehmen: Tag löschen, Release-Commit per git reset --keep entfernen (nur wenn noch nicht im Upstream). Greift auch bei einem Release-Commit ohne Tag (#13) |
Zwischen --local und --publish lässt sich das Artefakt aus dem fertigen
Tag bauen und testen (git describe liefert schon den Release-Tag).
Vorabversionen (--rc)
| Aufruf | Wirkung |
|---|---|
release --rc |
vX.Y.Z-rc.N taggen und veröffentlichen, N zählt selbst hoch (erster RC = rc.1); Forgejo-Release als Prerelease |
release --rc --local |
RC nur lokal, danach release --publish (bzw. --abort) |
release --final |
Final vX.Y.Z bei offener RC-Linie: CHANGELOG fasst alle RC-Abschnitte der Version zusammen |
- Versionsermittlung ignoriert RC-Tags (
git cliff --tag-pattern '^v[0-9]+\.[0-9]+\.[0-9]+$'). - Kam seit dem letzten RC nichts dazu, taggt der Final denselben Commit
wie der RC — kein neuer Release-Commit. Folge:
CHANGELOG.mdundVERSION=in diesem Commit zeigen noch den RC; die Release-Notes des Finals werden frisch erzeugt, die Datei holt der nächste Release nach. - Repos ohne RC-Tags laufen ohne Zusatzoption durch git-cliff, also wie vor
--rc. - Format
-rc.N(SemVer-sortierbar:rc.10>rc.9). Die alte Form-rcNwird weiter erkannt; eine Linie zählt über beide Formen weiter (v1.0.0-rc3→v1.0.0-rc.4). Ein Folge-RC fasst nichts zusammen: der CHANGELOG bekommt genau einen neuen Abschnitt.
Versionsstufe erzwingen (--bump)
--bump major|minor|patch (auch --bump=…) legt die Stufe fest, statt sie
aus den Commits abzuleiten; kombinierbar mit --rc und --local.
release --rc --bump major --local # 0.x → v1.0.0-rc.1, nur lokal
release --publish
release --rc # v1.0.0-rc.2 — offene RC-Linie gilt weiter
release --final # v1.0.0 — ohne --final bricht release ab
Offene RC-Linie: Gibt es RC-Tags über dem letzten Final, gibt deren Version
das Ziel vor (die höhere von berechneter und RC-Version gewinnt) — Folge-RCs
und Final brauchen kein erneutes --bump. Ohne changelog-relevanten Commit
seit dem letzten Release bumpt git-cliff auch mit --bump nicht → Abbruch.
Gate (#11): Bei offener Linie bricht release ohne --rc und ohne
--final ab — auch mit --yes. Ein Final ist eine Entscheidung, kein
Versehen (Vorfall: release --yes veröffentlichte v1.0.0 statt eines RC).
--final ohne offene Linie wirkt nicht; --rc --final wird abgewiesen.
RC-Linie verlassen: Ein Final (release --final) schließt sie. Aufgeben,
etwa 1.0.0-rc zurück auf 0.x, geht nur, indem Holm die RC-Tags der Linie
löscht, lokal und auf dem Remote; release löscht nie Tags einer Linie. Solange
die Linie offen ist, zeigt jeder Lauf → RC-Linie vX.Y.Z offen, Zielversion daraus.
Hilfe: release -h.
Voraussetzungen
git-cliffim PATH- GPG-Schlüssel konfiguriert (
git config user.signingkey) pass forgejo/api-token-release-cli— Token mitrepo/release-Scopejqim PATH
Installation
# Repo liegt bereits unter ~/git/forgejo.mueller.network/holm.tools.public/release/
ln -s /home/holm/git/forgejo.mueller.network/holm.tools.public/release/release.sh ~/bin/release
Was es tut
- Working tree auf Sauberkeit prüfen
- GPG-Signing rauchtest
- Nächste Version via
git cliff --bumped-versionermitteln VERSION="x.y.z"-Zeilen in tracked Dateien im Repo-Root auf die neue Version setzen (kein Treffer ⇒ Skip, abschaltbar per--no-version-bump)CHANGELOG.mdschreiben, committen (chore(release): vX.Y.Z)- Signierten Tag erstellen
- Push: Branch + dieser eine Tag atomar (
git push --atomic) - Forgejo-Release mit Changelog-Notizen anlegen
Tests
nix shell nixpkgs#bats --command bats test/
Sandbox-Repos mit Bare-Remote, pass/curl gestubbt; gpg ist echt
(entsperrter Agent nötig).
Changelog
Siehe CHANGELOG.md.
Lizenz
MIT — siehe LICENSE.