Git und das Review-System Gerrit in der TYPO3 Community. Vortrag auf dem TYPO3camp Stuttgart am 21.05.2011

1. TYPO3-Camp Stuttgart - 20.-22. Mai 2011 Inspiring people to
TYPO3-Entwicklung mit Git und Gerrit share

2. Verteilte Softwareentwicklung und -reviews
in der TYPO3-Community
Steffen Gebert <steffen.gebert@typo3.org>
Twitter: @StGebert
TYPO3-Camp Stuttgart - 20./22. Mai 2011
Inspiring people to
TYPO3-Entwicklung mit Git und Gerrit share

3. Einführung
Vorstellung
Steffen Gebert
TYPO3 Core Team Member
Diplom-Informatiker
Doktorand / Wissenschaftl. Mitarbeiter
an der Uni Würzburg
Inspiring people to
TYPO3-Entwicklung mit Git und Gerrit share

4. Einführung
Überblick
Software-Reviews
Git & Gerrit
Workflows & Konventionen
Weitere Informationen
Fragen
Inspiring people to
TYPO3-Entwicklung mit Git und Gerrit share

5. Software-Reviews
Foto: mario.rimann
http://www.flickr.com/photos/mrimann/3534514430/
Inspiring people to
TYPO3-Entwicklung mit Git und Gerrit share

6. Einführung
Software-Reviews
Qualitätssicherung
Vier (oder sechs) Augen sehen mehr als zwei
Fehler werden immer gemacht - man muss sie nur finden!
Aufnahme in offiziellen Quellcode erst nach erfolgtem Review
Verschiedene Arten des Reviews, u.a.
Funktionalität
Code
Inspiring people to
TYPO3-Entwicklung mit Git und Gerrit share

7. Software-Reviews
Funktionales Review
Eine Änderung...
behebt den Fehler / ermöglicht ein neues Feature
stört keine andere Funktionalität
Inspiring people to
TYPO3-Entwicklung mit Git und Gerrit share

8. Software-Reviews
Code-Review
Eine Änderung am Quellcode...
ist korrekt
(macht das, was sie tun soll und nichts anderes)
ist sinnvoll programmiert
(Robustheit, Performance, etc.)
entspricht gewünschten Programmierstandards
(z.B. TYPO3 Coding Guide Lines)
Testmethoden
Automatische Analyse (v.a. CGL)
Durchlesen
Inspiring people to
TYPO3-Entwicklung mit Git und Gerrit share

9. Software-Reviews
Review per Mailingliste (damals...)
“Requests for Comments” (RFCs) per core-team-Mailingliste
Formalitäten /
Konventionen

10. Software-Reviews
Review per Mailingliste
Voting
SVN Commit

11. Software-Reviews
Mailingliste: Ordnung halten
man kämpfte sich so durch...
Inspiring people to
TYPO3-Entwicklung mit Git und Gerrit share

12. Git & Gerrit
Migration zu Git & Gerrit
Präsentation auf Core-Team-Meeting im Juli 2010
Einigkeit über Einführung
Testkaninchen FLOW3 ab Aug. 2010
Migration für v4 während Code-Sprint am 1. März 2011
Erwartete Vorteile
Mehr Übersicht für Reviewer
Einfachere Entwicklung/Integration großer Features
Inspiring people to
TYPO3-Entwicklung mit Git und Gerrit share

13. Foto: tnimalan
Git & Gerrit im Einsatz
http://www.sxc.hu/photo/1275444
Inspiring people to
TYPO3-Entwicklung mit Git und Gerrit share

14. Git & Gerrit
Git Lokale Kopie des
Verteiltes Versionskontrollsystem gesamten Repositories
Entwickelt für die Linux-Kernelentwicklung von Linus Thorvalds
Sehr mächtig
Von Nerds für Nerds :-)
Komplexer als Subversion
Basiswissen wird im Folgenden vorausgesetzt
Danke an Tobias Günther für den Crashkurs
Inspiring people to
TYPO3-Entwicklung mit Git und Gerrit share

15. lokale Aktion Veröffentlichung
Inspiring people to
TYPO3-Entwicklung mit Git und Gerrit share

16. Git & Gerrit
Git: Wiederholung
“trunk” heißt jetzt “master”
Commits werden über SHA-1 identifiziert
Ein Commit ist lokal - jeder darf committen
Committs lassen sich nachträglich ändern
Branching ist alltäglich
Foto: texas_mustang
http://www.flickr.com/photos/astros/58932360/
Inspiring people to
TYPO3-Entwicklung mit Git und Gerrit share

17. Git & Gerrit
Repository klonen
git clone --recursive
git://git.typo3.org/TYPO3v4/Core.git
Meta-Informationen landen im Verzeichnis .git/
Ausgecheckter Branch: master
Gesamte History seit TYPO3 3.6 enthalten
Inspiring people to
TYPO3-Entwicklung mit Git und Gerrit share

18. Git & Gerrit
Gerrit
Web-basiertes Code-Review Tool
Für Android-Entwicklung von Google entwickelt
Baut auf Git als VCS auf
Wacht über das offizielle Git-Repository
Hauptgrund für die Migration des TYPO3-Codes nach Git
Inspiring people to
TYPO3-Entwicklung mit Git und Gerrit share

19. GIT “standalone”
GIT & Gerrit
Inspiring people to
TYPO3-Entwicklung mit Git und Gerrit share

20. Git & Gerrit
Gerrit
Momentan genutzt für
TYPO3v4: Core, Workspaces, Extbase, Fluid
Extensions: community, extension_builder (ehem.
extbase_kickstarter)
FLOW3
TYPO3v5
http://review.typo3.org
Inspiring people to
TYPO3-Entwicklung mit Git und Gerrit share

21. Git & Gerrit
Gerrit Übersicht
´
o
o

22. Git & Gerrit
Gerrit Change-Id
Jeder Change-Request hat eindeutige Change-Id
Inspiring people to
TYPO3-Entwicklung mit Git und Gerrit share

23. Patches reviewen
Foto: stylesr1
http://www.sxc.hu/photo/605324
Inspiring people to
TYPO3-Entwicklung mit Git und Gerrit share

24. Git & Gerrit
Änderung reviewen

25. Git & Gerrit
Änderung reviewen
Commit Message
➪ Konventionen

26. Git & Gerrit
Änderung reviewen
Reviews

27. Git & Gerrit
Änderung reviewen
Verschiedene
Patch-Versionen

28. Git & Gerrit
Code Review
Diff aufrufen

29. Git & Gerrit
Diff-Ansicht
Inspiring people to
TYPO3-Entwicklung mit Git und Gerrit share

30. Git & Gerrit
Diff-Ansicht
Inline-Kommentare mit Doppelklick
Inspiring people to
TYPO3-Entwicklung mit Git und Gerrit share

31. Git & Gerrit
Funktionaler Test
checkout wählen
kopieren

32. Git & Gerrit
Funktionaler Test
Befehlszeile ausführen
Exakter Stand wird ausgecheckt, incl. Änderung
Testen!
Inspiring people to
TYPO3-Entwicklung mit Git und Gerrit share

33. Git & Gerrit
Voting abgeben

34. Git & Gerrit
Voting abgeben
Funktionaler Test
-1/0/+1
Code Review
-1/0/+1
Anmerkungen -
besonders bei
negativem Review!

35. Git & Gerrit
Voting abgeben
Members only..
Anmerkungen -
besonders bei
negativem Review!

36. Foto: csremedy
Eigene Patches senden
http://www.sxc.hu/photo/1267108
Inspiring people to
TYPO3-Entwicklung mit Git und Gerrit share

37. Git & Gerrit
Git konfigurieren
git config --global user.name "Your Name"
git config --global user.email "foo@example.com"
muss mit Adresse in
Gerrit übereinstimmen
Inspiring people to
TYPO3-Entwicklung mit Git und Gerrit share

38. Git & Gerrit
Git konfigurieren
git config --global user.name "Your Name"
git config --global user.email "foo@example.com"
git config --global branch.autosetuprebase remote
git config --global
url."ssh://<username>@review.typo3.org:29418"
.pushInsteadOf git://git.typo3.org
Inspiring people to
TYPO3-Entwicklung mit Git und Gerrit share

39. Git & Gerrit
Git konfigurieren
git config --global user.name "Your Name"
git config --global user.email "foo@example.com"
git config --global branch.autosetuprebase remote
git config --global
url."ssh://<username>@review.typo3.org:29418"
.pushInsteadOf git://git.typo3.org
Inspiring people to
TYPO3-Entwicklung mit Git und Gerrit share

40. Git & Gerrit
Git konfigurieren
git config --global user.name "Your Name"
git config --global user.email "foo@example.com"
Push URL
git config --global branch.autosetuprebase remote
git config --global
url."ssh://<username>@review.typo3.org:29418"
.pushInsteadOf git://git.typo3.org
Fetch/Pull URL
Inspiring people to
TYPO3-Entwicklung mit Git und Gerrit share

41. Git & Gerrit
Gerrit: SSH-Key festlegen

42. Git & Gerrit
Gerrit Change-Id
Jeder Change-Request hat eindeutige Change-Id
Inspiring people to
TYPO3-Entwicklung mit Git und Gerrit share

43. Git & Gerrit
Gerrit Change-Id
Automatische Generierung über Git Commit Hook
submodule ≅
cd typo3_src-git
scp -p -P 29418 svn:externals
<username>@review.typo3.org:hooks/commit-msg
.git/hooks/
git submodule update --init
git submodule foreach 'scp -p -P 29418
<username>@review.typo3.org:hooks/commit-msg
.git/hooks/'
Inspiring people to
TYPO3-Entwicklung mit Git und Gerrit share

44. Git & Gerrit
Eigene Änderung senden

45. Git & Gerrit
Eigene Änderung senden
Aktuellen Stand bekommen
git checkout <release-branch> z.B. master
git pull
TYPO3_4-5
Änderung am Code durchführen TYPO3_4-4
Änderung reviewen
git diff
Committen
git commit -a
Inspiring people to
TYPO3-Entwicklung mit Git und Gerrit share

46. Git & Gerrit
Commit Message Format
CM verbleibt auf ewig in der History
Spezielle Konventionen für Commit Message
[BUGFIX] Recursion error when including TypoScript files
Text
When editing TypoScript in the template module and using
the "Include TypoScript file content" option with more than 9
files, then the 10th and all later files gets screwed up.
Resolves: #25374
Releases: 4.6, 4.5
Inspiring people to
TYPO3-Entwicklung mit Git und Gerrit share

47. Git & Gerrit
Commit Message Hook
git log -1
zeigt letzte Commit Message an
Change-Id-Zeile wurde automatisch hinzugefügt
(ansonsten weigert Gerrit später die Annahme)
[BUGFIX] Recursion error when including TypoScript files
When editing TypoScript ...
Change-Id: 69fb8866b94c75b3b73395cfa4bd0a900e6ab53c
Resolves: #25374
Releases: 4.6, 4.5
Inspiring people to
TYPO3-Entwicklung mit Git und Gerrit share

48. Git & Gerrit
Änderung pushen
git push origin HEAD:refs/for/<release-branch>
gewünschter Remote
alternativ z.B. github
Inspiring people to
TYPO3-Entwicklung mit Git und Gerrit share

49. Git & Gerrit
Änderung pushen
git push origin HEAD:refs/for/<release-branch>
z.B. master
TYPO3_4-5
Stand des eigenen Pseudo-Branch TYPO3_4-4
Working-Tree in Gerrit
Gerrit antwortet mit Erfolgsmeldung “New Changes” und
Review-URL
Inspiring people to
TYPO3-Entwicklung mit Git und Gerrit share

50. Workflows & Konventionen
Inspiring people to
TYPO3-Entwicklung mit Git und Gerrit share

51. Workflows & Konventionen
Review-Workflow
Issue in Forge eröffnen
Commit machen, Pushen
Auf Reviews warten
Nachbessern mit neuer Patch-Version oder
freuen :-)
Ggf. weitere Branches pushen
Inspiring people to
TYPO3-Entwicklung mit Git und Gerrit share

52. Workflows & Konventionen
Grundsätzliches
Change Request bezieht sich jeweils auf einen Branch
Nur ein Eintrag für alle Branches in Forge erforderlich
Nach erfolgreichem Review automatisch im nächsten Release
Inspiring people to
TYPO3-Entwicklung mit Git und Gerrit share

53. Workflows & Konventionen
Aktive Branches
master (wird später TYPO3_4-6 abgespalten)
TYPO3_4-5 (current stable, LTS)
TYPO3_4-4 (oldstable)
TYPO3_4-3 (oldoldstable)
Inspiring people to
TYPO3-Entwicklung mit Git und Gerrit share

54. Workflows & Konventionen
In welchen Branch..?
Features, Änderungen des Verhaltens
master (keine Features in veröffentlichten Versionen)
Bugfixes
master (4.6) master nicht
current stable (4.5) vergessen!
LTS (4.5)
ältere Branches nach Belieben (4.4, 4.3)
Inspiring people to
TYPO3-Entwicklung mit Git und Gerrit share

55. Workflows & Konventionen
Erforderliche Reviews
Change Request wird gemerged bei jeweils mindestens
Verified Code Review
Team-Mitglied ✓ (+2) ✓ (+2)
Beliebiger
+1 +1
Reviewer
Weitere Reviews sind willkommen!
Übernahme (“Submit”) durch Team-Mitglied in Gerrit
Inspiring people to
TYPO3-Entwicklung mit Git und Gerrit share

56. Workflows & Konventionen
Mr. Hudson & Mr. Jenkins
Jenkins Continuous Integration Server (vormals Hudson)
Automatisiertes Review
Momentane Tests
Coding Guide Lines
PHP lint
TODO
Unit Tests
http://ci.typo3.org
Inspiring people to
TYPO3-Entwicklung mit Git und Gerrit share

57. Weitere Informationen
Foto: Egilshay
http://www.sxc.hu/photo/1095604
Inspiring people to
TYPO3-Entwicklung mit Git und Gerrit share

58. Weitere Informationen
Git-Probleme
Screenshot Google
Pro Git Buch
http://progit.org (kostenlos)
Inspiring people to
TYPO3-Entwicklung mit Git und Gerrit share

59. Weitere Informationen
Wiki: “Git” landing page
Git Grundlagen

60. Weitere Informationen
Wiki: “Git” landing page
Quellcode über
Git beziehen

61. Weitere Informationen
Wiki: “Git” landing page
Contributing
(interessant ;-))

62. Weitere Informationen
Wiki: “Git” landing page
Workflow
nochmals erklärt

63. Weitere Informationen
Wiki: “Git” landing page
Klappt was nicht?

64. Weitere Informationen
Wiki: “Git” landing page
nice to know...

65. Weitere Informationen
Wiki: “Git” landing page
Begrifflichkeiten
erklärt

66. Weitere Informationen
Wiki: Tutorials
toll!!

67. Weitere Informationen
Wiki: Tutorials
doof...

68. Weitere Informationen
Wiki: Ausfürliche CLI-Anleitung

69. Weitere Informationen
Probleme?
Fragen!
Mailinglisten / Newsgroups
typo3.core
typo3.dev
lists.typo3.org
Inspiring people to
TYPO3-Entwicklung mit Git und Gerrit share

70. Weitere Informationen
Nicht angesprochen...
Neue Patchversion erstellen modifiziert vorherigen
git commit --amend Commit
Inspiring people to
TYPO3-Entwicklung mit Git und Gerrit share

71. ?????
??
?
??
??
?
Inspiring people to
TYPO3-Entwicklung mit Git und Gerrit share

72. inspiring people to share.