File-Release

Aus THM-Wiki
Wechseln zu: Navigation, Suche

Um ein neues File-Release für den Download bei SourceForge zu erzeugen, ist einiges an Vorarbeit nötig.

Merge des Branches Non-MNI

Der Branch enthält die Version, die bei SourceForge veröffentlich werden kann, also ohne alle MNI-spezifischen Änderungen wie z.B. LDAP-Login, MNI-Portal-Integration etc.

Der Branch muss auf den Stand des aktuellen Entwicklungsbranches gebracht werden. Es ist dabei sinnvoll, sich die gravierendsten Änderungen für den späteren News-Eintrag bei SourceForge zu notieren. Auch sollte überprüft werden, ob alle Datenbankänderungen und Datei-Updates für das Updatescript notiert wurden.

Zu ignorierende Dateien und Ordner

  • doku (wird von Anwendern nicht benötigt)
  • eStudy/common/classes/class.ldaplogin.inc.php (FH-spezifischer LDAP-Login)
  • eStudy/user/notenliste.php (MNI-spezifisch)
  • Vorlagen (wird von Anwendern nicht benötigt)

Außer den Styles basic_css, osx, osx_low, planspiel_lights und den sp_planspiel_*-Styles sollten auch keine Styles in das Paket übernommen werden. Andere Styles können separat als Download angeboten werden.

Zu ignorierende Code-Teile

  • eStudy/anmeldung.php:
    • Einbindung der Klasse LDAPLogin.
    • Kein neues Passwort und keinen neuen Account erstellen, falls LDAP-Nutzer.
  • common/footer.inc.php und common/install.footer.inc.php:
    • Anzeige des FH-Logos.
  • eStudy/common/classes/class.auth.inc.php:
    • Einbindung der Klasse LDAPLogin.
  • eStudy/common/mkf/estudy.sql:
    • Am Ende der Datei befinden sich die INSERTs der Einstellungen. Die 8 Einstellungen bzgl. des LDAP-Logins sollten hier auskommentiert sein.

Update-Script

Das Update-Script befindet sich im Verzeichnis eStudy. Es enthält alle Datenbankänderungen seit dem letzten Release und bietet die Möglichkeit, nicht mehr benötigte Dateien zu löschen und neue Modulgruppen zu installieren.

Wichtig ist, bei jedem Update die interne Versionsnummer auf das Release-Datum zu setzen. Der Rest ist aus dem schon vorhandenen Scriptcode abzuleiten.

Test

Testen Sie die Installation des neuen Pakets und das Update einer älteren Version ausführlich!

Laden Sie dazu das letzte File-Release bei SourceForge herunter, installieren Sie es und updaten Sie die Installation mit dem neu erzeugten Paket.

Prüfen Sie sowohl bei der frischen Installation als auch bei der Update-Installation folgende Punkte:

  • Enthält der logs-Ordner SQL-Fehlerprotokolle von dem Update/der Installation (ausgenommen Fehler wegen schon vorhandenen Tabellen und Einträgen beim Update).
  • Lässt sich ein neuer Benutzer anlegen?
  • Lassen sich neue Kurse anlegen?
  • Lassen sich Foren anlegen?
  • Haben die allgemeinen Einstellungen sinnvolle Standardwerte?
  • ...

Paket schnüren

Kopieren Sie nun den Ordner des Non-MNI-Branches, um daraus ein Zip-Archiv zu erstellen. Nennen Sie ihn eStudy_<Versionsnummer>.

Löschen Sie aus diesem Ordner folgende Dateien, wenn vorhanden:

  • CVS-Verzeichnisse
  • .cvsignore
  • .project
  • eStudy/common/config.inc.php
  • estudy_connect.inc.php
  • eStudy/logs/*.log
  • sessions/sess_*

Achten Sie darauf, dass alle sonst leeren Verzeichnisse eine Datei attic enthalten (wie z. B. in sessions), da die Verzeichnisse sonst nicht von allen Packern ins Archiv übernommen werden.

Erstellen Sie nun eine Zip-Datei aus dem Ordner.

File-Release erstellen

Eine Umfangreiche Anleitung zum Erstellen von File-Releases gibt es bei Sourceforge.

In Kurzform:

  • Laden Sie die Zip-Datei per FTP auf folgenden Server hoch:
    • Host: upload.sourceforge.net
    • Benutzername: anonymous
    • Passwort: <sf-net-E-Mail-Adresse>
    • Verzeichnis: /incoming
  • Öffnen Sie die Seite File Releases im Admin-Bereich des eStudy-Projektes bei SourceForge.net.
  • Klicken Sie unten beim Package estudy auf Add Release.
  • Nennen Sie das neue Release eStudy <Versionsnummer>.
  • Fassen Sie die Änderungen seit dem letzten Release als Notes zusammen, klicken Sie auf Submit/Refresh.
  • Wählen Sie die hochgeladene Datei aus und klicken Sie auf Add Files and/or Refrech View.
  • Wählen Sie als Processor Platform-Independent und als File Type .zip. Klicken Sie auf Update/Refresh.

Die Datei ist nun zum Download verfügbar. Überprüfen Sie den Download nochmal genauso wie die Installation.

Verfassen Sie nun noch einen News-Beitrag. Der kann den selben Text beinhalten, wie die Release Notes.