Per GIT am LoxBerry Core entwickeln

Dieser Text wurde für LoxBerry V0.2.x entwickelt. Mit LoxBerry V1.0 wurde LoxBerry Update eingeführt. Mit LoxBerry Update kann das System - je nach Einstellung auch automatisch - aktualisiert werden. Das kann Eure Änderungen ohne Vorwarnung überschreiben, wenn ihr direkt im System entwicklelt! Der Autor dieses Artikels entwickelt daher aktuell nicht mehr auf diese Art, sondern legt sich ein separates Development-Verzeichnis direkt auf dem LoxBerry an, aus dem heraus er Änderungen committet.

Wer am LoxBerry Core entwickeln möchte, macht dieses am einfachsten direkt auf einem Entwicklungs-RaspberryPi und veröffentlicht seine gemachten Änderungen per GIT. Das hat den Vorteil, dass das Entwicklungssystem immer auf dem gleichen Stand wie das GIT Repository ist und man mit seinem System zudem auch auf dem identischen Stand aller anderen Entwickler ist.

Die nachfolgende Anleitung beschreibt die Schritte, die dazu notwendig sind.

Daher ist es sinnvoll, vor Änderungen an Dateien jeweils das aktuelle Repository zu clonen und die Berechtigungen nicht neu zu setzen!

Ist man kein LoxBerry Hauptentwickler und hat somit Schreibzugriff auf das Original-Repository, legt man als aller erstes einen "Fork" des Original-Repositories an. Vereinfacht gesagt kopiert man sich damit das Original-Repository in den eigenen GIT-Account und kann dort dann sämtliche Änderungen hineinschreiben ("committen"). Ist man mit seinen Änderungen fertig, macht man einen sogenannten Pull-Request, was soviel bedeutet wie eine Anfrage an die Hauptentwickler, den eigenen Code zu übernehmen. 

Wer zu den Stammentwicklern gehört kann diesen Schritt überspringen.

Jetzt installiert man das letzte Entwicklungsimage welches verfügbar ist auf einer freien SD-Karte. Das Entwicklungsimage findet man auf den Downloadservern im Unterverzeichnis /testing/images. Es macht Sinn den Setup-Assistenten nach dem ersten booten nicht zu durchlaufen und zu überspringen.

Meist enthält das Image nicht die allerletzten Änderungen des GIT-Repositories. Daher müssen zunächst die im Image enthaltenen Dateien aktualisiert werden. Dazu verbindet man sich per SSH mit dem LoxBerry, wechselt zum user "root" und führt folgende Befehle aus:

KONSOLE cd /opt

KONSOLE rm -r /opt/loxberry

KONSOLE  git clone https://github.com/mschlenstedt/Loxberry.git -b loxberry-0.3.0-saruman loxberry

KONSOLE /opt/loxberry/sbin/resetpermissions.sh

Die oben genannte GIT-Adresse funktioniert nur, wenn man zu den Core-Entwicklern gehört und direkt in das Original-Repository schreiben darf. Ansonsten gibt man hier die GIT-Adresse zum eigenen Fork im eigenen GIT-Account an. Zudem muss natürlich der entsprechend gerade aktuelle Branch (Parameter -b) angegeben werden.

Nun muss man noch GIT den eigenen Namen und die eigene Emailadresse bekannt geben:

KONSOLE git config --global user.email "DEINE EMAIL ADRESSE"

KONSOLE git config --global user.name "DEIN NAME"

Ab jetzt kann man Änderungen an den Quelltexten vornehmen. Alle Änderungen werden dabei lokal von GIT "getrackt". Geänderte Dateien kann man sich zu jeder Zeit anzeigen lassen:

KONSOLE git status

Alle geänderten Dateien, die man nun veröffentlichen möchte (committen), fügt man nun mit folgendem Befehl dem Commit hinzu:

KONSOLE  git add DATEINAME

Oft wird in GIT-Tutorials empfohlen, einfach alle geänderten Dateien mittels git add . zu committen. Das sollte man nie tun: Sehr häufig passiert es dabei, dass man so aus Versehen Konfigursationsdateien oder sonstige private Daten aus Versehen ins GIT Repository committet. Einmal veröffentlicht sind sie so gut wie nicht mehr löschbar! Zudem würden eigene Konfigurationsdateien das Repository unbrauchbar machen. Wenn man sich unsicher ist, wass man dem Commit hinzugefügt hat, hilft ein git status weiter.

Ist man zufireden erzeugt man den Commit, gibt einen ausführlichen Text der gemachten Änderungen ein (in Englisch) und läd die Änderungen mit einem "Push" zu GIT hoch:

KONSOLE  git commit (Es öffnet sich der Standardeditor, meist nano, zur Eingabe einer ausführlichen Beschreibung)

oder

KONSOLE  git commit -m "A short Description"

KONSOLE  git push

Um von anderen Entwicklern gemachte Änderungen von GIT zu holen, führt man einen Pull aus:

KONSOLE  git pull