Entwicklung/Git: Unterschied zwischen den Versionen
Git-Installatiion ist bereits auf einer anderen Seite beschrieben
(Git-Installatiion ist bereits auf einer anderen Seite beschrieben) |
|||
| (11 dazwischenliegende Versionen von 7 Benutzern werden nicht angezeigt) | |||
| Zeile 1: | Zeile 1: | ||
== Versionsverwaltung der Entwicklungsdaten mit Git == | == Versionsverwaltung der Entwicklungsdaten mit Git == | ||
Das Opencaching.de-Projekt verwendet [ | Das Opencaching.de-Projekt verwendet [https://github.com/ Git] zur Verwaltung von Quellcode, Dokumentationen etc. Git ist leistungsfähiger und komplexer als klassische Versionsverwaltungstools wie CVS und Subversion. Es kann wesentlich besser mit Branches umgehen, also verschiedenen Codeversionen eines Projekts -- "branches (in Git) are cheap and easy". So kann man zu Testzwecken, zum Programmieren einzelner Features etc. eigene Zweige anlegen, die dann später wieder in den Haupt-Code (den ''Master-Branch'') einfließen oder wahlweise verworfen werden. Dieses Verzweigen und Wieder-Zusammenführen von Codeversionen ist erstaunlich einfach und zuverlässig. Richtig eingesetzt, erleichtert es das Projektmanagement. | ||
Die Verwendung von Git setzt eine gewisse Lernkurve voraus. Diese Anleitung soll dir den Einstieg erleichtern und erklärt alles, was du für den Git-Einsatz bei Opencaching.de wissen musst (und Einiges mehr). Sie erklärt die Verwendung von Git anhand der Kommandozeilenversion, die für alle relevanten Betriebssysteme erhältlich ist. Daneben gibt es verschiedene komfortable Benutzeroberflächen. Gerne kannst du ein weiteres Kapitel für die von dir bevorzugte Git-UI hinzufügen! | Die Verwendung von Git setzt eine gewisse Lernkurve voraus. Diese Anleitung soll dir den Einstieg erleichtern und erklärt alles, was du für den Git-Einsatz bei Opencaching.de wissen musst (und Einiges mehr). Sie erklärt die Verwendung von Git anhand der Kommandozeilenversion, die für alle relevanten Betriebssysteme erhältlich ist. Daneben gibt es verschiedene komfortable Benutzeroberflächen. Gerne kannst du ein weiteres Kapitel für die von dir bevorzugte Git-UI hinzufügen! | ||
Allgemeine Einführungen in Git findest du z.B. hier (Liste gerne ergänzen): | Allgemeine Einführungen in Git findest du z.B. hier (Liste gerne ergänzen): | ||
* | * https://rogerdudler.github.io/git-guide/index.de.html - Der einfache Einstieg (deutsch) | ||
* | * https://docs.github.com/de - eine leichtverständliche Einführung | ||
* | * https://www.stefanimhoff.de/git/ - Sammlung von einfachen und komplexeren Tutorials (englisch) | ||
== Funktionsweise von Git und Einsatz bei Opencaching.de == | == Funktionsweise von Git und Einsatz bei Opencaching.de == | ||
| Zeile 27: | Zeile 14: | ||
Die Entwickler können in beliebigen Topologien organisiert werden und gleichen den Inhalt ihrer Repositories wechselseitig miteinander ab. Opencaching.de verwendet eine Art Sternstruktur, mit einem Haupt-Repository unter der Adresse | Die Entwickler können in beliebigen Topologien organisiert werden und gleichen den Inhalt ihrer Repositories wechselseitig miteinander ab. Opencaching.de verwendet eine Art Sternstruktur, mit einem Haupt-Repository unter der Adresse | ||
* | * https://github.com/OpencachingDeutschland/oc-server3 | ||
Auf dieses Repo haben nur der Code Maintainer und seine Vertreter Schreibzugriff; alle anderen können nur lesen. Um auch Daten hochladen zu können, besitzt jeder Entwickler bei | Auf dieses Repo haben nur der Code Maintainer und seine Vertreter Schreibzugriff; alle anderen können nur lesen. Um auch Daten hochladen zu können, besitzt jeder Entwickler bei GitHub.com eine eigene Kopie - einen "Fork" - des Haupt-Repositories, z.B. | ||
* | * https://github.com/flopp/oc-server3 | ||
Dein erster Schritt als Opencaching-Entwickler ist das Anlegen deines Forks. Dazu legst du dir auf [ | Dein erster Schritt als Opencaching-Entwickler ist das Anlegen deines Forks. Dazu legst du dir auf [https://github.com GitHub] einen kostenlosen Account an, gehst auf https://github.com/OpencachingDeutschland/oc-server3 und klickst oben rechts auf "Fork". | ||
Der zweite Schritt ist, dir eine lokale Kopie - einen "Klon" - deines Forks anzulegen. Wie du das im OC.de-Entwicklersystem machst, ist im Artikel [[Entwicklung/Entwicklersystem|Entwicklersystem]] beschrieben. Hier machen wir es einfach mal testweise - du kannst so viele Klone anlegen wie du möchtest, den GitHub-Repositories ist das egal: | |||
git clone git@github.com:<DeinBenutzername>/oc-server3 | |||
Nun wird bei dir ein Verzeichnis <code>oc-server3/.git</code> angelegt, das zunächst eine 1:1-Kopie deines GitHub-Forks ist (der zunächst eine 1:1-Kopie des Opencaching-Deutschland-Repos ist), und von dort der komplette aktuelle OC.de-Code in Unterverzeichnisse von <code>oc-server3</code> ausgecheckt. In <code>oc-server3</code> befinden sich also sowohl deine Arbeitsdaten als auch der lokale Repository-Klon. <code>oc-server3/.git/config</code> ist die Konfigurationsdatei des lokalen Repositories, die du aber nur selten von Hand bearbeiten wirst. | |||
Dein GitHub-Fork heißt in deinem lokalen Repository ''origin''; über diesen Name kannst du mit verschiedenen Git-Kommandos darauf zugreifen. Um die Konfiguration abzuschließen, muss zusätzlich noch der ''upstream'' definiert werden - das Repository, aus dem du neue Daten abrufst. Dies ist nicht dein eigener Fork, sondern du beziehst die Daten direkt von OpencachingDeutschland. Navigiere dazu ins Verzeichnis <code>oc-server3</code> und führe dann folgenden Befehl aus: | |||
git remote add upstream git@github.com:OpencachingDeutschland/oc-server3 | |||
git remote add upstream | |||
Mit <code>git remote -v</code> kannst du dir nun alle "remote"-Repositories anzeigen lassen, die in deinem Klon eingestellt sind. | Mit <code>git remote -v</code> kannst du dir nun alle "remote"-Repositories anzeigen lassen, die in deinem Klon eingestellt sind. | ||
== Installation == | |||
Die Installation und Einrichtung von Git ist im Artikel [[Entwicklungsumgebung einrichten#Github|Entwicklungsumgebung einrichten]] beschrieben. | |||
== Datenfluss == | == Datenfluss == | ||
| Zeile 56: | Zeile 48: | ||
== Daten bearbeiten und hochladen == | == Daten bearbeiten und hochladen == | ||
Nach dem ersten Auschecken ist der '' | Nach dem ersten Auschecken ist der ''development''-Branch aktiv. Dieser enthält den aktuellen Entwicklungsstand. Welcher Branch aktiv ist, siehst du mit | ||
git branch | |||
Unser Standard-Workflow sieht vor, dass '''nie im | Unser Standard-Workflow sieht vor, dass '''nie im development gearbeitet wird'''. Stattdessen musst du dir - ausgehend von ''development'' - für jede Aufgabe einen Arbeitsbranch anlegen: | ||
git checkout -b 1234-new-feature development | |||
Die vorangestellte Nummer ist eine Ticketnummer aus der Todo-Liste. Wenn es keine passende gibt, lässt du sie weg. Verwende nach Möglichkeit englische Namen und Kommentare, denn das OC-Projekt ist international vernetzt. Nun kannst du mit <code>git branch</code> sehen, dass es in deinem lokalen Repo zwei Branches gibt, und der neu angelegte ist aktiv. Mit dem Kommando <code>git checkout Branchname</code> kannst du zwischen den Branches hin- und herwechseln; dabei wird jeweils der Code in den Arbeitsdaten entsprechend ausgetauscht. | Die vorangestellte Nummer ist eine Ticketnummer aus der Todo-Liste. Wenn es keine passende gibt, lässt du sie weg. Verwende nach Möglichkeit englische Namen und Kommentare, denn das OC-Projekt ist international vernetzt. Nun kannst du mit <code>git branch</code> sehen, dass es in deinem lokalen Repo zwei Branches gibt, und der neu angelegte ist aktiv. Mit dem Kommando <code>git checkout Branchname</code> kannst du zwischen den Branches hin- und herwechseln; dabei wird jeweils der Code in den Arbeitsdaten entsprechend ausgetauscht. | ||
Beim Anlegen des Branches sind wir davon ausgegangen, das unmittelbar zuvor der Klon angelegt wurde und die lokale | Beim Anlegen des Branches sind wir davon ausgegangen, das unmittelbar zuvor der Klon angelegt wurde und die lokale development-Kopie aktuell ist. Wenn Letzteres evtl. nicht der Fall ist, solltest du sie vor dem Anlegen des neuen Branches aktualisieren: | ||
git checkout | git checkout development | ||
git pull upstream | git pull upstream | ||
git checkout -b 1234-new-feature [ | git checkout -b 1234-new-feature [development] | ||
Nun ist es soweit: Du kannst deine ersten Änderungen am OC-Code vornehmen und hochladen! Zum Bearbeiten musst du einen UTF8-fähigen Editor verwenden. Dass er das ist, erkennst du an den zwei japanischen Sonderzeichen oben in jeder Quelltextdatei: Wenn dort zwei Fragezeichen, Klötzchen oder Ähnliches erscheinen, ist dein Editor falsch eingestellt oder ungeeignet. Zum Thema Editoren/IDEs siehe auch im Forum: "[http://forum. | Nun ist es soweit: Du kannst deine ersten Änderungen am OC-Code vornehmen und hochladen! Zum Bearbeiten musst du einen UTF8-fähigen Editor verwenden. Dass er das ist, erkennst du an den zwei japanischen Sonderzeichen oben in jeder Quelltextdatei: Wenn dort zwei Fragezeichen, Klötzchen oder Ähnliches erscheinen, ist dein Editor falsch eingestellt oder ungeeignet. Zum Thema Editoren/IDEs siehe auch im Forum: "[http://forum.opencaching.de/index.php?topic=2150.0 Git-UI / PHP-IDE]" | ||
Wenn du die Änderungen vorgenommen hast, zeigt dir | Wenn du die Änderungen vorgenommen hast, zeigt dir | ||
git status | |||
in roter Farbe an, welche Dateien geändert oder hinzugefügt wurden, und | in roter Farbe an, welche Dateien geändert oder hinzugefügt wurden, und | ||
git diff | |||
die Änderungen im Einzelnen. Falls dein Editor bzw. deine | die Änderungen im Einzelnen. Falls dein Editor bzw. deine Entwicklungsumgebung irgendwelche zusätzlichen Dateien angelegt hat, kannst du diese in <code>.git/info/exclude</code> eintragen, damit sie nicht ins Repository gelangen. | ||
Als nächstes musst du Git mitteilen, dass die Daten zum aktiven Branch hinzugefügt werden sollen; dies geschieht mit | Als nächstes musst du Git mitteilen, dass die Daten zum aktiven Branch hinzugefügt werden sollen; dies geschieht mit | ||
git add . | |||
für alle geänderten und neuen Dateien im aktuellen Verzeichnisbaum (falls du Branches gewechselt hast vergewissere dich evtl. mit <code>git branch</code>, dass du im richtigen bist!) Wahlweise kannst du einzelne Dateien per (Pfad+)Dateiname hinzufügen oder Wildcards verwenden. Dateien löschen kann man mit | für alle geänderten und neuen Dateien im aktuellen Verzeichnisbaum (falls du Branches gewechselt hast vergewissere dich evtl. mit <code>git branch</code>, dass du im richtigen bist!) Wahlweise kannst du einzelne Dateien per (Pfad+)Dateiname hinzufügen oder Wildcards verwenden. Dateien löschen kann man mit | ||
git rm Dateiname | |||
Nun zeigt <code>git status</code> in grüner Farbe alle vorbereiteten Änderungen an, und mit | Nun zeigt <code>git status</code> in grüner Farbe alle vorbereiteten Änderungen an, und mit | ||
git commit | |||
checkst du sie in dein lokales Repository ein. Es öffent sich ein vi-Editor, in dem du einen Kommentar eingeben musst. Schreibe eine aussagekräftige, möglichst englische Zusammenfassung in die erste Zeile, und evtl. zusätzliche Erläuterungen in die weiteren Zeilen. Wenn es nur ein einzeiliger Kommentar sein soll, kannst du dir den Editor auch sparen und den Kommentar direkt angeben mit | checkst du sie in dein lokales Repository ein. Es öffent sich ein vi-Editor, in dem du einen Kommentar eingeben musst. Schreibe eine aussagekräftige, möglichst englische Zusammenfassung in die erste Zeile, und evtl. zusätzliche Erläuterungen in die weiteren Zeilen. Wenn es nur ein einzeiliger Kommentar sein soll, kannst du dir den Editor auch sparen und den Kommentar direkt angeben mit | ||
git commit -m "Kommentar" | |||
Wenn keine neuen Dateien hinzugefügt, sondern nur vorhandene geändert werden sollen, kannst du auch das <code>add</code> mit einbauen, also alle geänderten Daten mit nur einem Befehl einchecken: | Wenn keine neuen Dateien hinzugefügt, sondern nur vorhandene geändert werden sollen, kannst du auch das <code>add</code> mit einbauen, also alle geänderten Daten mit nur einem Befehl einchecken: | ||
git commit -am "Kommentar" | |||
Mit | Mit | ||
git log | |||
siehst du nun, dass ein neuer ''commit'' in die Versionsgeschichte des aktiven Branches eingefügt wurde. Wahlweise kannst du auch mit <code>git log --stat</code> nochmals alle geänderten Dateien anzeigen lassen. | siehst du nun, dass ein neuer ''commit'' in die Versionsgeschichte des aktiven Branches eingefügt wurde. Wahlweise kannst du auch mit <code>git log --stat</code> nochmals alle geänderten Dateien anzeigen lassen. | ||
Um den Commit mit einem Ticket in der [[Entwicklung/Todo-Liste| | Um den Commit später mit einem Ticket in der [[Entwicklung/Todo-Liste|Jira]] zu verknüpfen, kannst du im Kommentar die Ticket Nummer (inklusive Projekt Kürzel) angeben. Aktuell übernimmt es das jedoch nur für Pull Requests. Dort sollte die Ticket Nummer am Anfang stehen. | ||
==== Exkurs: | ==== Exkurs: Commits ==== | ||
Commits sind das Hauptelement der Arbeit mit Git. Jeder Branch ist eine bestimmte Abfolge von Commits. Verschiedene Branches unterscheiden sich dadurch, welche Commits sie enthalten. Ein Commit ist ein Patch, der eine oder mehrere Dateien verändert, hinzufügt und/oder löscht. Jeder Commit hat einen eindeutigen Hashcode, der im Log angezeigt wird. Über diesen Code lassen sich Commits einzeln herauspicken, rückgängig machen, als Diff anzeigen etc. Dabei genügt die Angabe der ersten paar Zeichen, sofern sie eindeutig sind; üblich als Kurzform sind die ersten 7-10 Zeichen. | Commits sind das Hauptelement der Arbeit mit Git. Jeder Branch ist eine bestimmte Abfolge von Commits. Verschiedene Branches unterscheiden sich dadurch, welche Commits sie enthalten. Ein Commit ist ein Patch, der eine oder mehrere Dateien verändert, hinzufügt und/oder löscht. Jeder Commit hat einen eindeutigen Hashcode, der im Log angezeigt wird. Über diesen Code lassen sich Commits einzeln herauspicken, rückgängig machen, als Diff anzeigen etc. Dabei genügt die Angabe der ersten paar Zeichen, sofern sie eindeutig sind; üblich als Kurzform sind die ersten 7-10 Zeichen. | ||
Der letzte (neueste) Commit des aktiven Branches hat auch den Name HEAD, der vorletzte HEAD~1, der drittletzte HEAD~2 etc. Mit | Der letzte (neueste) Commit des aktiven Branches hat auch den Name HEAD, der vorletzte HEAD~1, der drittletzte HEAD~2 etc. Mit | ||
git diff HEAD~1 | |||
kannst du dir z.B. alle Änderungen zwischen aktuellem und vorletztem Codestand anzeigen lassen - also genau das, was du mit deinem letzten <code>commit</code> eingecheckt hast. | kannst du dir z.B. alle Änderungen zwischen aktuellem und vorletztem Codestand anzeigen lassen - also genau das, was du mit deinem letzten <code>commit</code> eingecheckt hast. | ||
| Zeile 105: | Zeile 97: | ||
Zunächst solltest du deine Daten nochmal auf den aktuellen Stand bringen. Damit ist sichergestellt, dass deine Änderungen mit dem aktuellsten OC-Code funktionieren: | Zunächst solltest du deine Daten nochmal auf den aktuellen Stand bringen. Damit ist sichergestellt, dass deine Änderungen mit dem aktuellsten OC-Code funktionieren: | ||
git fetch upstream | git fetch upstream | ||
git rebase upstream/ | git rebase upstream/development | ||
Das erste Kommando aktualisiert deine lokale Kopie der Upstream-Branches (die du mit <code>git branch -r</code> auflisten kannst), bzw. legt diese erstmalig an. Das zweite übernimmt alle neuen ''commits'' aus dem Upstream - also dem OC-Hauptrepository - in deinen aktiven Branch, und zwar fügt es sie ''vor'' deine eigenen Änderungen ein! Deine Änderungen werden auf Basis des aktuellen OC-Codestandes neu aufgesetzt (re-based), d.h. sie werden als Patch auf diesen Codestand angewandt. Beide Kommandos lassen sich auch zu einem zusammenfassen: | Das erste Kommando aktualisiert deine lokale Kopie der Upstream-Branches (die du mit <code>git branch -r</code> auflisten kannst), bzw. legt diese erstmalig an. Das zweite übernimmt alle neuen ''commits'' aus dem Upstream - also dem OC-Hauptrepository - in deinen aktiven Branch, und zwar fügt es sie ''vor'' deine eigenen Änderungen ein! Deine Änderungen werden auf Basis des aktuellen OC-Codestandes neu aufgesetzt (re-based), d.h. sie werden als Patch auf diesen Codestand angewandt. Beide Kommandos lassen sich auch zu einem zusammenfassen: | ||
git pull --rebase upstream | git pull --rebase upstream development | ||
'''Verwende niemals ein einfaches <code>git pull</code> (ohne <code>--rebase</code>) in einem Arbeitsbranch!''' Es würde die Versionsgeschichte unlesbar machen und das Zurückverfolgen von Codeänderungen verhindern. | '''Verwende niemals ein einfaches <code>git pull</code> (ohne <code>--rebase</code>) in einem Arbeitsbranch!''' Es würde die Versionsgeschichte unlesbar machen und das Zurückverfolgen von Codeänderungen verhindern. | ||
| Zeile 118: | Zeile 110: | ||
Nun kannst du deinen neuen Branch mit | Nun kannst du deinen neuen Branch mit | ||
<code>git push origin 1234-new-feature</code> | <code>git push origin 1234-new-feature</code> | ||
in deinen Fork hochladen. Wenn du auf [http://github.com/ http://github.com/<DeinUsername>/oc-server3] links die Branch-Dropdown-Box aufklappst, oder weiter rechts auf "branches" klickst, sollte dort der neue Branch auftauchen (manchmal mit etwas Verzögerung). Wenn du oben auf "Network" klickst, siehst du wie dein neuer Branch vom | in deinen Fork hochladen. Wenn du auf [http://github.com/ http://github.com/<DeinUsername>/oc-server3] links die Branch-Dropdown-Box aufklappst, oder weiter rechts auf "branches" klickst, sollte dort der neue Branch auftauchen (manchmal mit etwas Verzögerung). Wenn du oben auf "Network" klickst, siehst du wie dein neuer Branch vom development abzweigt. Jeder Punkt in diesem Diagramm steht für einen ''commit''. | ||
Wenn dein Branch fertig ist und in den | Wenn dein Branch fertig ist und in den development übernommen werden soll, wählst du ihn aus der Branches-Liste aus und klickst oben auf "Pull Request"; hier kannst du noch einen zusätzlichen Kommentar angeben. Der Code Maintainer wird per E-Mail informiert und wird deinen Code prüfen und ggf. übernehmen. | ||
In diesem Fall war es wahrscheinlich nur ein Test, daher kannst du den Branch nun mit | In diesem Fall war es wahrscheinlich nur ein Test, daher kannst du den Branch nun mit | ||
git push origin :1234-new-feature | git push origin :1234-new-feature | ||
wieder aus deinem Fork löschen. Wenn du ihn auch lokal wieder löschen willst, geht das mit | wieder aus deinem Fork löschen. Wenn du ihn auch lokal wieder löschen willst, geht das mit | ||
git checkout | git checkout development | ||
git branch -D 1234-new-feature | git branch -D 1234-new-feature | ||
Das große <code>-D</code> ermöglicht es, einen Branch zu verwerfen, der nicht weiterverwendet wurde. Wenn du stattdessen <code>-d</code> angibst, sind nur Branches löschbar die bereits in einen anderen Branch (z.B. den | Das große <code>-D</code> ermöglicht es, einen Branch zu verwerfen, der nicht weiterverwendet wurde. Wenn du stattdessen <code>-d</code> angibst, sind nur Branches löschbar die bereits in einen anderen Branch (z.B. den development) übernommen wurden, wo durch die Löschung also keine Daten verloren gehen können. '''Im Zweifelsfall verwende immer -d'''; dabei kann nichts versehentlich verloren gehen. | ||
==== Zusammenfassung des OC-Git-Standard-Workflow ==== | ==== Zusammenfassung des OC-Git-Standard-Workflow ==== | ||
Neuen Branch für eine neue Aufgabe anlegen | * Neuen Branch für eine neue Aufgabe anlegen | ||
*# <code>git checkout development</code> | |||
*# <code>git pull upstream</code> | |||
*# <code>git checkout -b 1234-new-feature</code> | |||
*: ... oder die Arbeit an einem bereits bestehenden Branch mit <code>git checkout 1234-new-feature</code> fortsetzen | |||
... oder die Arbeit an einem bereits bestehenden Branch mit <code>git checkout 1234-new-feature</code> fortsetzen | * Programmierzyklen | ||
*# Code schreiben | |||
Programmierzyklen | *# mit <code>git status</code> / <code>git diff</code> lokale Änderungen kontrollieren | ||
*# Änderung mit <code>git add</code> / <code>git commit</code> ins lokale Repo einchecken | |||
*# mit <code>git pull --rebase upstream development</code> auf aktuellen OC-Code aufsetzen | |||
*# weiter bei 1, wenn der Code noch nicht fertig ist | |||
* Hochladen | |||
*# <code>git push origin 1234-neues-Feature</code> | |||
*# ''Branch 1234-neues-Feature'' auf GitHub aufrufen und Pull Request starten | |||
* Nicht mehr benötigte Branches löschen | |||
Hochladen | *# lokal: <code>git checkout development</code> / <code>git branch -d 1234-neues-Feature</code> | ||
*# auf dem Fork: <code>git push origin :1234-neues-Feature</code> | |||
Nicht mehr benötigte Branches löschen | |||
==== Commits zusammenfassen ==== | ==== Commits zusammenfassen ==== | ||
| Zeile 168: | Zeile 153: | ||
Wenn du selbst gerade nichts programmieren willst, sondern dir einfach nur ein Update vom OC-Server holen und anschauen, machst du | Wenn du selbst gerade nichts programmieren willst, sondern dir einfach nur ein Update vom OC-Server holen und anschauen, machst du | ||
git checkout | git checkout development | ||
git pull upstream | git pull upstream | ||
Wenn du mehrere Branches mit eigenen Änderungen angelegt hast, und diese alle im Zusammenhang testen möchtest, kannst du dir dafür einen Testbranch anlegen: | Wenn du mehrere Branches mit eigenen Änderungen angelegt hast, und diese alle im Zusammenhang testen möchtest, kannst du dir dafür einen Testbranch anlegen: | ||
git checkout -b test | git checkout -b test development | ||
git merge 1234-new-feature | git merge 1234-new-feature | ||
git merge 2345-my-bugfix | git merge 2345-my-bugfix | ||
| Zeile 190: | Zeile 175: | ||
* <code>git revert commit-ID</code> | * <code>git revert commit-ID</code> | ||
* <code>git push</code> | * <code>git push</code> | ||
* evt. Pull-Request auf dem | * evt. Pull-Request auf dem GitHub, wenn es bereits im Upstream angekommen war | ||
Den Kommentar des letzten, noch nicht "gepushten" Commit korrigieren: | Den Kommentar des letzten, noch nicht "gepushten" Commit korrigieren: | ||
| Zeile 198: | Zeile 183: | ||
Wenn du z.B. den Branch ''1234-new-feature'' von Entwickler ''heinz'' testen möchtest, kannst du ihn in einen Testbranch bei dir herunterladen. Zunächst musst du ''heinz''' Fork einmalig als weitere Upstream definieren: | Wenn du z.B. den Branch ''1234-new-feature'' von Entwickler ''heinz'' testen möchtest, kannst du ihn in einen Testbranch bei dir herunterladen. Zunächst musst du ''heinz''' Fork einmalig als weitere Upstream definieren: | ||
git remote add heinz | git remote add heinz git@github.com:heinz/oc-server3 | ||
Dann legst du bei dir einen Testbranch an, am besten auf Basis aktuellster Daten ... | Dann legst du bei dir einen Testbranch an, am besten auf Basis aktuellster Daten ... | ||
git checkout | git checkout development | ||
git pull upstream | git pull upstream | ||
git checkout -b tolles-heinz-feature | git checkout -b tolles-heinz-feature | ||
| Zeile 208: | Zeile 193: | ||
== Der stable-Branch == | == Der stable-Branch == | ||
Neben dem | Neben dem development gibt es im OC-Repository einen Branch "stable". Dieser enthält immer den gleichen Stand wie das Produktivsystem www.opencaching.de. Neue Features werden im development entwickelt und getestet und später über den Stable-Branch freigegeben. | ||
Mit dem Stable-Branch wirst du nur dann zu tun haben, wenn du einen "Hotfix" schreibst - eine dringende Korrektur, die sofort freigegeben werden soll. Diese setzt du auf dem Stable statt dem | Mit dem Stable-Branch wirst du nur dann zu tun haben, wenn du einen "Hotfix" schreibst - eine dringende Korrektur, die sofort freigegeben werden soll. Diese setzt du auf dem Stable statt dem development auf; der übrige Workflow ist der gleiche wie oben beschrieben. | ||
== Vereinfachter Workflow == | == Vereinfachter Workflow == | ||
Der oben beschriebene Workflow ist Pflicht für alle Entwickler, die Code zu OC.de beitragen. Wer nur hin und wieder mal eine Grafik oder einen Text beisteuert, kann ausnahmsweise auch ohne separate Branches arbeiten. In diesem Fall ist ein '''einfaches <code>git pull</code> im | Der oben beschriebene Workflow ist Pflicht für alle Entwickler, die Code zu OC.de beitragen. Wer nur hin und wieder mal eine Grafik oder einen Text beisteuert, kann ausnahmsweise auch ohne separate Branches arbeiten. In diesem Fall ist ein '''einfaches <code>git pull</code> im development-Branch verboten'''! Stattdessen muss überall, wo oben <code>git pull upstream</code> steht, stattdessen | ||
<code>git pull --rebase upstream | <code>git pull --rebase upstream development</code> | ||
verwendet werden! Der vereinfachte Ablauf ist dann: | verwendet werden! Der vereinfachte Ablauf ist dann: | ||
| Zeile 221: | Zeile 206: | ||
2. mit <code>git status</code> / <code>git diff</code> lokale Änderungen kontrollieren<br> | 2. mit <code>git status</code> / <code>git diff</code> lokale Änderungen kontrollieren<br> | ||
3. Änderung mit <code>git add</code> / <code>git commit</code> ins lokale Repo einchecken<br> | 3. Änderung mit <code>git add</code> / <code>git commit</code> ins lokale Repo einchecken<br> | ||
4. mit <code>git pull --rebase upstream | 4. mit <code>git pull --rebase upstream development</code> auf aktuellen OC-Code aufsetzen<br> | ||
5. weiter bei 1, wenn der Code noch nicht fertig ist<br> | 5. weiter bei 1, wenn der Code noch nicht fertig ist<br> | ||
6. git push origin<br> | 6. <code>git push origin</code><br> | ||
7. Pull-Request | 7. Pull-Request | ||
== Noch ein paar Gimmicks == | == Noch ein paar Gimmicks == | ||
zeigt die Doku für ein Git-Kommando an. | * <code>git branch -m 1234-neuestes-Feature</code> Benennt den derzeit aktiven Branch um in "1234-neuestes-Feature". | ||
* <code>git diff Branchname</code> zeigt alle Unterschiede zwischen dem aktuellen Branch und einem anderen an. | |||
* <code>git cherry-pick Commit-ID</code> übernimmt einen bestimmten Commit (von wo auch immer) in den aktiven Branch. | |||
* <code>git diff --name-only --diff-filter=U</code> zeigt eine Liste aller konfliktbehafteten Dateien nach einem Merge an | |||
* <code>git gc</code> führt eine [http://de.wikipedia.org/wiki/Garbage_Collection Garbage Collection] durch und gibt Platz im lokalen Repository frei. Per <code>git reset --hard</code> oder <code>git branch -d</code> gelöschte Commits werden damit endgültig weggeworfen (vorher sind sie via <code>git reflog</code> noch wiederherstellbar). | |||
* <code>git grep Suchbegriff</code> durchsucht den Code des aktuellen Verzeichnisbaums; für zahlreiche Optionen siehe Git-Doku. | |||
* <code>git help Kommando</code> zeigt die Doku für ein Git-Kommando an. | |||
== Forenbeiträge zu Git == | == Forenbeiträge zu Git == | ||
* [http://forum. | * [http://forum.opencaching.de/index.php?topic=2125.0 Git-Workflow] | ||
[[Kategorie:Entwicklung|Git]] | [[Kategorie:Entwicklung|Git]] | ||