project_version

Projektversion (EXT:project_version)

Was ist eine Projektversion?

Die Projektversion ist eine TYPO3 Erweiterung, die einen Eintrag zu den TYPO3-Systeminformationen in der Symbolleiste hinzufügt. Dieser Eintrag basiert entweder auf der gemeinsamen Datei'VERSION' oder auf der lokalen GIT-Revision.

Wie installiere ich es?

Stellen Sie zunächst sicher, dass Sie die Anforderungen erfüllen:

Composer

Fordern Sie einfach die Erweiterung vom Packagisten an: composer erfordert kamiyang/ext-projectversion

Oder wenn du typo3-ter bevorzugst: composer erfordert typo3-ter/projectversion

TER

Kein composer verfügbar? Kein Problem! Sie finden diese Erweiterung auch im Extension Repository (TER) von TYPO3. Sie können es direkt aus Ihrem TYPO3 heraus herunterladen, solange sich Ihr TYPO3 nicht im composer-Modus befindet

Wie benutze ich es?

"VERSION"-Datei

Nun, das ist der einfachste Teil. Erstellen Sie in Ihrer TYPO3-Frontend-Doku mit der Projektversion eine Datei namens VERSION (Groß-/Kleinschreibung beachten). Das kann man so machen: $ echo 1.0.0.0-rc.3 > /var/wwww/html/VERSION

Benutzerdefinierter Pfad

Du kannst deinen eigenen Dateinamen und Pfad verwenden. Beachten Sie, dass dieser Pfad noch von Ihrem Web-Docroot aus zugänglich sein muss. Die Konfiguration kann in der ExtensionConfiguration vorgenommen werden. Es ist auch möglich, das Verzeichnis der 'VERSION'-Datei zu ändern. Geben Sie nur einen Verzeichnispfad an (mit folgendem Schrägstrich '/') und es wird automatisch nach einer Datei namens'VERSION' gesucht.

Beispiele: Wir gehen davon aus, dass die Webdokument-Root (PATH_site) /var/wwww/html ist.

GIT

Seit Release 0.3.0 wird Git unterstützt. Diese muss manuell aktiviert werden. Um git nutzen zu können, stellen Sie sicher, dass es verfügbar ist! Ein häufiger Fall ist, dass die lokale Entwicklungsumgebung auf Docker-Images basiert. Viele Docker-Bilder haben keinen Git out of the box zur Verfügung. Um es zu aktivieren, wechseln Sie einfach über Ihren bevorzugten Webbrowser in das TYPO3-Backend. Für TYPO3 v8.7 - gehen Sie zu "Erweiterungen > Projektversion" und konfigurieren Sie die Erweiterung. Der Konfigurationsbildschirm sieht standardmäßig so aus

Das hat sich in TYPO3 v9 ein wenig geändert. Um die Erweiterung zu konfigurieren, gehen Sie zu "Einstellungen > Erweiterungen konfigurieren" und filtern Sie nach "Projektversion". Der neue Konfigurationsbildschirm sieht wie folgt aus:

Konfigurationsmöglichkeiten

grundmodus

basic.gitFormat

Roadmap zu v1.0.0.0

• [x] Unterstützung für statische VERSION-Dateien
• x] Möglichkeit zur Konfiguration des "VERSION"-Dateipfades hinzugefügt
• [x] GIT-Revisionsunterstützung
• x] GIT-Tag/Zweig auf Basis der Revisionsunterstützung
• Dokumentation der Funktionen dieser Erweiterungen hinzufügen
• [x] Erweiterung auf packagist.org hochladen
• [x] Erweiterung zu TER hochladen
• x] Unterstützung von TYPO3 v9.4
• [x] Unterstützung von TYPO3 v9 LTS
• x] Erreichen einer Gesamttestabdeckung von über 95%
• x] TravisCI konfigurieren
• x] StyleCI konfigurieren
• x] Overalls konfigurieren
• x] Statischer VERSIONswert über die Erweiterungskonfiguration

Meilenstein für v0.6.0

• Möglichkeit der "Hardcodierung" der statischen Projektversion über das TYPO3-Backend

Hinweis

Die TYPO3 v8-Version dieser Erweiterung wird nach Release 1.0.0.0 nicht mehr gepflegt! Das sollte aber kein Problem sein, denn TYPO3 v8 bekommt nur Bugfixes. Das bedeutet, dass die Version 1.0.0.0 mit allen weiteren TYPO3 v8 Releases kompatibel bleiben sollte!

Nach der Freigabe der Version 1.0.0, die um die Veröffentlichung der ersten TYPO3 v9 LTS-Version herum erfolgen wird, wird EXT:project_version auf php7.2 umgestellt und integriert TYPO3 v9-Funktionen.