Installation & Einrichtung
Es wird empfohlen, ein privates GitHub-repo für die eigene Belegarbeit zu erstellen. Nachfolgend sind die nötigen Schritte zur Einrichtung angegeben:
Alle Maschinen, auf denen am Beleg geschrieben werden soll, müssen auf GitHub authentifiziert sein. Das kann über HTTPS oder SSH (empfohlen) erfolgen. Eine bereits vorhandene Anmeldung via user/pass oder SSH-Schlüssel wird in dieser Anleitung vorausgesetzt. Siehe: https://docs.github.com/en/free-pro-team@latest/github/authenticating-to-github/connecting-to-github-with-ssh
Auf GitHub ein neues repo erstellen
Einen repo-Namen vergeben und die Einstellungen unten auf den Standardwerten lassen. Für Belege wird empfohlen, ein privates repo zu verwenden:
Von der folgenden Seite die clone-URL kopieren (SSH oder HTTPS)
Diese wird in Schritt 3 benötigt. In diesem Beispiel wird git@github.com:jemand771/latex-test.git verwendet.
Zunächst das gerade erstellte repo irgendwohin klonen:
git clone git@github.com:jemand771/latex-test.git
Als nächstes muss die Vorlage als remote eingebunden werden. Das kann entweder über SSH (git@github.com:ba-latex/Vorlage-Latex.git) oder HTTPS (https://github.com/ba-latex/Vorlage-Latex.git) erfolgen. In dieser Anleitung wird SSH verwendet.
git remote add vorlage git@github.com:ba-latex/Vorlage-Latex.git
git pull vorlage master
git checkout master
git push origin master
vorlage ist dabei der remote-name und kann frei gewählt werden.
Ganz normal mit git arbeiten, z.B.
git add bla
git commit -m "bla hinzugefügt"
git push
Wird ein neuer lokaler branch erstellt, muss beim ersten push darauf die richtige remote angegeben werden. Danach geht alles wie vorher.
git checkout -b neuer-branch
git push -u origin neuer-branch
# dinge ändern, add, commit ...
git push
(Hinweis an Vorlagen-Collaborators: nicht aus versehen nach vorlage pushen ;) )
Zunächst müssen alle lokalen Änderungen commited bzw. stashed sein. Danach:
git pull origin master
Sollten Merge-Konflikte entstehen, müssen diese zunächst gelöst und die Änderung commited werden. Das sollte nicht häufig passieren. (Vorlage ändert Beispiel-Dateien. Bitte auch Changelog beachten)
git push nach dem merge nicht vergsesen, um den aktuellen Stand auf GitHub zu veröffentlichen.
Alternativ https://github.com/ba-latex/Vorlage-Latex aufrufen und den aktuellen master als zip herunterladen:
Vorlagen-Updates gestalten sich mit dieser methode eher schwer.