Release Verfahren

Die folgende Anleitung beschreibt, wie eine neue Version des DAPNET Web-Frontends released wird. Dabei wird davon ausgegangen, dass die Entwicklung in einem development-Branch durchgeführt wird und die aktuell stabile Version in einem master-Branch liegt.

1. Abhängigkeiten & Template aktualisieren

Zunächst sollten die verwendeten Abhängigkeiten und das Template aktualisiert werden.

Ein Aufruf von npm outdated zeigt dazu die zur Zeit verwendeten Versionen und die aktuellste Version an. Wichtig: zur Zeit wird webpack in der Version 3 verwendet, welches mit einigen vorgeschlagenen Aktualisierungen inkompatibel ist. Daher zuerst die Changelogs prüfen! Nach dem entsprechenden Erhöhen der Versionsnummern werden die Abhängigkeiten lokal durch ein npm install installiert.

Die Änderungen des verwendeten Templates sollten ebenfalls in die Codebasis eingepflegt werden. Dazu müssen die Unterschiede zwischen den Releases verglichen und zum Teil angepasst werden.

Abschließend muss das Projekt natürlich noch mittels npm run dev fehlerfrei gebaut werden.

2. Versionsnummer erhöhen & Merge

Die Versionsnummer innerhalb der package.json-Datei muss erhöht werden. Dabei orientiert sich das Projekt an den Vorgaben der semantischen Versionierung.

Daraufhin wird diese Änderung als neuer Commit in das Git-Repository eingepflegt:

git add package.json
git commit -m "v1.2.3"

Nun werden alle Änderungen aus dem development-Branch in den master-Branch übernommen und auf den development-Branch zurückgewechselt:

git checkout master
git merge development
git checkout development

3. Tag & Release erstellen

Auf Grundlage dieses Commits wird nun ein neuer Tag erstellt und mit allen vorherigen Commits in das GitHub-Repository gepusht:

git tag v1.2.3
git push origin development
git push origin master
git push origin master --tags

Dieser Tag ist nun unter https://github.com/DecentralizedAmateurPagingNetwork/Web/releases zu finden und muss mit einem entsprechenden Changelog ausgestattet werden. Dieser wird durch folgenden Befehl anhand der Änderungen zwischen den beiden angegebenen Tags erzeugt:

git log v1.2.2...v1.2.3 --pretty=format:'* %s - %h'

4. Update-Check aktualisieren

Zum Abschluss muss die angegebene Version des Update-Checks noch aktualisiert werden. Dies geschieht im entsprechenden Repository. Hier wird die Versionsnummer in der Datei dapnet-web-current-version.txt geändert und anschließend committed:

git add dapnet-web-current-version.txt
git commit -m "Web: v1.2.3"
git push