Projekt BISO 3 - Handbuch
TBD
Es wird folgendes Versionierungs-Schema angewandt:
Grundsätzlich: Versionierungsschema nach semver.
grunt export erstellt einen vollen Build nach export/[version]/.Die API-Doc wird mit Swagger als HTML-Seite erstellt. Die gesamte API-Spezifikation ist im File doc/api-doc/biso-api.swagger.json
als OpenAPI-Spezifikation hinterlegt.
Build:
$ cd doc/api-doc/
$ npm install
$ npm run build # --> erstellt die fertige Doku im "dist/"-Folder
$ cp -r dist/ ziel/pfad/fuer/die/doku/
Die Infopage / FAQ ist eine Informationsseite inkl. Changelogs und FAQs über BISO. Sie wird unter https://biso.kadenpartner.ch/ publiziert.
Build:
# Build:
$ npm install
$ grunt infopage
# Deploy:
$ rsync -rcv --delete doc/infopage/site/ root@webhosting-docker.kp.local:/data/biso-kadenpartner/biso.kadenpartner.ch/
Für die Installation auf Produktions-Systemen gilt folgendes Vorgehen:
Auf dem Entwicklungssystem wird ein fertiges Produktions-Paket erstellt:
$ grunt package
Dies erstellt ein zip-File mit dem Produktions-Paket unter export/biso-[version].zip. Dieses Paket wird auf das Kundensystem kopiert.
Auf dem Produktionssystem wird nun das Installationspaket installiert:
# Entpacken des Installations-ZIP:
unzip biso-[version].zip
# Kopieren der neuen Dateien ins Webroot (bestehende Files überschreiben):
rsync -rcv biso-[version]/ /pfad/zum/biso/webroot/
Nach der Installation des neuen Webroot müssen die anstehenden Datenbank-Migrationen ausgeführt werden. Dies passiert ebenfalls auf dem produktiven Web-Server mittels PHP:
$ cd /pfad/zum/biso/webroot
$ php biso-cli migration exec
Sollte es während der DB-Migration zu Fehler kommen, müssen wir (Kaden und Partner) informiert werden und investigieren.
Beim Upgrade von BISO V2 auf V3 sind manuelle Tätigkeiten notwendig, da diverse Major-Versionen aktualisiert werden.
webroot/public-Directory zeigen. Das webroot/-Dir selber ist von aussen nicht mehr erreichbar, nur noch der public/-Folder.in der Konsole folgendes eingeben
PATH_TO_POSTGRES\pg_dump.exe --file "PATH_TO_BACKUP\BISO_BACKUPFILE" --host "localhost" --port "5432" --username "USERNAME" --no-password --verbose --role "biso" --format=c --blobs --no-owner --no-privileges --encoding "UTF8" "DATABASE_NAME"
public führt