GIT WARSZTATY

Wprowadzenie do GIT

Krzysztof Morcinek & Tomasz Skraskowski

www.gitwarsztaty.pl

Kwestie organizacyjne

• Prośba o zalogowanie się na kanał slackowy
• Po warsztatach prośba o uzupełnienie ankiety

VCS to dobra rzecz

Tak to się kiedyś robiło ;)

Polecamy korzystanie z systemu kontroli wersji nie tylko do programowania

Konsola & Gitk & Kdiff3

Konfiguracja środowiska

Różne edytory tekstowe

• vim
  git config --global core.editor vim
• Linux Mint - xed
  git config --global core.editor xed
• Ubuntu - gedit
  git config --global core.editor gedit
• Windows - notepad
  git config --global core.editor notepad
• Windows - notepad++
  git config --global core.editor "'C:/Program Files/Notepad++/notepad++.exe' -multiInst -notabbar -nosession -noPlugin"
• Windows - Visual Studio Code
  git config --global core.editor "'C:\Program Files\Microsoft VS Code\code.exe' -n -w"

git config --global -e

Trzy poziomy konfiguracji

• --system (brany pod uwagę na końcu)
  • Linux: /etc/gitconfig
  • Windows: %ProgramFiles(x86)%\Git\etc\gitconfig
  • Windows: %ProgramFiles%\Git\mingw64\etc\gitconfig
• --global (brany pod uwagę w drugiej kolejności)
  • Linux: ~/.gitconfig
  • Windows: %USERPROFILE%\.gitconfig
• --local (brany pod uwagę w pierwszej kolejności)
  • .git/config

Modyfikowanie konfiguracji

• git config --POZIOM SEKCJA.NAZWA "TREŚĆ"
  • Np. git config --global user.name "John Doe"
• git config --POZIOM --edit
  • Np. git config --global -e

Domyślny poziom przy zapisywaniu to local

Odczytywanie konfiguracji

• W edytorze tekstowym: git config (--POZIOM) --edit
  • Np. git config --global -e
• Konkretny wpis: git config (--POZIOM) SEKCJA.NAZWA
  • Np. git config --get user.email
• Listowanie wpisów: git config (--POZIOM) --list
  • Np. git config --list

Bez podania poziomu, git przyjmuje obecnie brany pod uwagę poziom

GIT to dobry wybór :)

• jest szybki
• jest rozproszony
• ułatwia rozwiązywanie konfliktów
• wspiera nieliniowy development (branche)
• działa offline
• pozwala na pracę nad jakością commitów
• bardzo łatwy do użytku domowego
• jest bezpieczny

Jest bezpieczny - jest wiarygodny

Suma kontrolna każdego commita opiera się na

• Zawartości i nazwach wszystkich plików
• ID parent commit(ów)
• Wiadomości (opisie) commita
• Autorze i/lub commiterze

Analogicznie wiarygodne są przelewy w bitcoin

Demo i ćwiczenie Proste flow

cwiczenia/#simple-flow
Tworzenie commitów z konsoli

Flow

Working directory,
staging area, commit

Twoje pliki - absolutnie każdy plik który utworzysz/edytujesz/usuniesz,
zawsze jest w którymś z 3 "obszarów" gita

• obszarze roboczym (working directory)
• 'indeksie' (staged files)
• repozytorium (commicie dodanym do historii)

Obszar roboczy

Obszar roboczy (working directory) to obszar w którym jest praca którą wykonałeś, ale o której jeszcze nie powiedziałeś nic gitowi

• nowe pliki których wcześniej nie commitowałeś
• zmiany w plikach które wcześniej commitowałeś
• zmiana nazwy pliku lub jego usunięcie

Git nie wie nic o Twojej pracy w working directory, uważaj żeby jej nie stracić dopóki mu o niej nie powiesz

Zmiany w working directory odnoszą się do staging area, a jeśli danego pliku nie ma w staging area, wówczas bezpośrednio do obecnej wersji w lokalnym repozytorium

Index (staged files)

Po zastagowaniu zmiany, czyli przygotowaniu jej do commita, dalej można plik edytować, wówczas zmiany w working directory pokazywane są względem zastagowanej wersji

Co więcej, od razu można wybrać żeby zastagować tylko część zmian Dla przykładu na dole pliku zaczęliśmy dopisywać nowy kod, a w środku pliku zobaczyliśmy literówkę w tekście. Wówczas można od razu nieprzerywając pracy na dole pliku, zastagować jedynie poprawienie literówki i dodać commita "Fix typo in module A".

Commit

Przykład stagowania (git add)

Przykład stagowania (git add)

Przykład stagowania (git add)

Przykład stagowania (git add)

Przykład stagowania (git add)

Przykład stagowania (git add)

Przykład stagowania (git add)

Przykład stagowania (git add)

Przykład stagowania (git add)

Przykład stagowania (git add)

Przykład stagowania (git add)

Przykład stagowania (git add)

Head

• HEAD - ostatni commit (pierwszy od końca) - np. ed8ab42[...]
• HEAD~1 - przedostatni commit - np. daa6b92[...]
• HEAD^ - przedostatni commit - np. daa6b92[...]
• HEAD~3 - czwarty od końca commit - np. 7cb16f7[...]
• HEAD^^^ - czwarty od końca commit - np. 7cb16f7[...]

Edytowanie wprowadzonych zmian

• Przed opublikowaniem innym
• Po opublikowaniu innym

Edycja 'ostatnich' commitów przed opublikowaniem

• git reset
  • git reset --mixed
  • git reset --soft
  • git reset --hard
• commit --amend
• rebase
• rebase --interactive

Edycja 'ostatnich' commitów po opublikowaniu

git revert

np:

• git revert HEAD
• git revert HEAD~4
• git revert 6e5av3a

Modyfikacja working directory i staging area

• git checkout *PATH*
• git reset --hard
• git clean (-d -f -n)

Ćwiczenie wspólnie z demo reset, revert, commit ammend

cwiczenia/#reset-revert-commit-ammend

Pytania?

rebase --interactive

rebase --interactive

Przenosimy linie tekstu w edytorze

Zmieniamy komendy z początków linii w edytorze

Zawsze wnikliwie czytamy podpowiedzi gita, piszemy git status gdy znikną

cwiczenia/#rebase-interactive-demo

Branche

cherry-pick

Commity między branchami można przekładać

Demo

pokazanie jak zmiana brancha wpływa na zawartość katalogów (git checkout)

stosowanie cherry-pick w praktyce

Merge

Rebase

Merge vs rebase

Git Guitar Hero

cwiczenia/#rebase-vs-merge

Rebase to świetne narzędzie...

... ale w niektórych sytuacjach trzeba uważać.
Czasami łatwiej przerwać rebasowanie i jeżeli flow projektu na to pozwala, jednak zrobić zwykłego merge.
(głównie przy starych, mocno rozjechanych branchach)

• rebase zakłamauje historię
• rebase może wywołać konflikty których by nie było przy mergu
• a w związku z tym, może wprowadzić błąd na produkcję
• pomijając, że to dokłada dodatkowej roboty

Konflikty

• Są czymś naturalny w środowisku gdzie niezależne osoby działają

• Tak wygląda powstały konflikt w kodzie

  

cwiczenia/#resolve-conflicts

Git to w zasadzie baza danych

Pushowanie
&
pullowanie zmian

Synchronizacja repozytoriów (np. lokalnego z wersją na GitHubie) odbywa się za pomocą 'wypychania' i 'ciągnięcia' commitów

• git push
• git pull
  • git fetch
  • git merge

Pull z rebase

git pull --rebase
git config --global --bool pull.rebase true

cwiczenia/#push-at-the-same-time

Push --force

git push --force

Przeglądanie historii

• git log
• gitk

Git log oraz gitk domyślnie pokazują historię od obecnego momentu - HEAD, ale możliwe jest wskazanie dowolnego momentu w historii, np. nazwy brancha, SHA commita lub odniesienia SHA^ lub SHA~N
np. HEAD^, master~5

Popularne przełączniki do git log / gitk

• git log -4
• git log --oneline
• git log --graph
• git log --decorate
• git log --stat
• git log --patch
• git log --since=X, git log --after=X, git log --before=X
• git log X --not Y, git log Y..X, git log X...Y
• git log --author="xyz"
• git log --grep="xyz" -i
• git log --no-merges
• git log --all
• git log --pretty="FORMAT"
• git log -S"text" -i
• Wyjście ze strumienia logów - klawisz q

git log z grafem

git log z jednoliniowymi wynikami

git log z pokazaną statystyką i diffem

gitk

Szukanie w ładnych toolach

• Jest ładne
• Jest ograniczone
• Wymaga oderwania się od konsoli

Przygotowanie do ćwiczeń z przeglądaniem historii

1. Przejdź do katalogu ćwiczeń na pulpicie:
   cd ~/Desktop/cwiczenia
2. Sklonuj przykładowe repozytorium (z projektem open source), do katalogu log-demo:
   git clone https://gitlab.com/terrakok/gitlab-client log-demo
3. Przejdź do katalogu repo: cd log-demo
4. Zresetuj repozytorium do wersji: 7ad14ecda2f97a3ff7c3cca44cc7605484b578b5
   git reset --hard 7ad14
   Żeby każdy miał tę samą wersję do ćwiczeń
   

Sprawdź tytuł ostatniego commita autora z nazwiskiem Gulya

Odpowiedź:
Upgrade Markwon to version 2.0.0. Replace ImageSizeResolver workaround with upstream one.

Pytania?

Sprawdź autora commita zawierającego w opisie frazę Update Stub

Odpowiedź:
terrakok

Pytania?

Sprawdź kto podniósł wersję produktu z 9 na 10 (text w kodzie: versionCode 10)

Odpowiedź:
terrakok, w commicie
6d289b10a07bb13d75a7b9767b9b0ae52b0421ce
Pytania?

Sprawdź jakie pliki modyfikował commit b9272a3be3d4f9182e6893a0f9a2f7b9ff0b6923

Sprawdź co dokładnie zmienił commit 0e02008383a59f6ab56a14df4688070aab925765

Odpowiedź:
Linie dodane do pliku PrivacyPolicyFragment.kt:
override val parentScopeName = DI.APP_SCOPE
pusta
Toothpick.inject(this, scope)
Linia usunięta z pliku PrivacyPolicyFragment.kt:
Toothpick.inject(this, Toothpick.openScope(DI.APP_SCOPE))

Pytania?

Sprawdź id commitów z drugiego grudnia 2018

Odpowiedź:
Nie ma takich
Pytania?

gitk pokazujący cały stan projektu

Ignorowanie plików

Ścieżki do plików/katalogów które chcemy ignorować dla repozytorium, trzymamy w pliku .gitignore

Plik ten wersjonujemy w repozytorium

Przykładowe reguły ignorowania

• *.orig
• **/[Pp]ackages/*
• bin/
• !src/Todo.csproj.user - wykluczenie od reguły (zaczyna się od wykrzyknika)

git-scm.com/docs/gitignore#_pattern_format

Dodaję regułę do .gitignore, a "git status" dalej pokazuje zmiany

Jest to scenariusz na który każdy prędzej czy później się natknie

Powód jest prosty - plik już jest w repozytorium,
.gitignore ignoruje tylko nie śledzone pliki

Wystarczy plik... usunąć z repozytorium

Usuwanie pliku z repozytorium, żeby "posłuchał" reguł .gitignore

• Tradycyjnie:
  usunięcie pliku -> git add -> git commit
• Za pmocą komendy:
  git rm file1.txt
git commit -m "remove file1.txt"
• Zostawiając plik na dysku:
  git rm --cached file1.txt
git commit -m "remove file1.txt"

Gotowe reguły .gitignore

• www.gitignore.io
• checkbox przy tworzeniu nowego projektu
• Krzyśka Morcinka ;) .gitignore

7 zasad dobrego commit message

1. Oddziel tytuł od ciała pustą linią
2. Ogranicz tytuł do 50 znaków
3. Stosuj wielkie litery w tytule
4. Nie kończ tytułu commita kropką
5. Zapisuj tytuł w trybie rozkazującym
6. Ogranicz 'szerokość' ciała do 72 znaków
7. Opisz co i dlaczego, a nie jak

https://chris.beams.io/posts/git-commit/

git reflog

schowek

• git stash
• git stash --include-untracked
• git stash list
• git stash apply (optional: name)
• git stash pop (optional: name)
• git stash drop (optional: name)
• Różne wariacje, zachowywanie indexu, nadawanie wiadomości itd.

Uwaga
Łatwo zapomnieć o nieśledzonych plikach

Forki & Pull requesty

Pytania? - Pull requesty!

cwiczenia/#forks-pull-request

Jak działa git

W przeciwieństwie do kryptowalut...

możesz zmieniać istniejące snapshoty (commity)

ALE!

wiedząc, że jakoś trzeba się z innymi zsynchronizować :)

Git nie śledzi plików

W przeciwieństwie do niektórych VCS,
git nie śledzi plików, wyłącznie ich zawartość

Przydatne narzędzia związane z gitem

• GitHub Pages / GitLab Pages / Netlify
  • Np. prezentacja na którą właśnie patrzymy:
    gitwarsztaty.pl/prezentacja
• GitHub gist

Tagi

Lekkie(lightweight) - tylko wskaźnik z nazwą
git tag v1.4

Opisane(annotated) - posiadają opis, sumę kontrolną, autora, datę itd.
git tag -a v1.4 -m 'my version 1.4'

Pushowanie tagów

Fetch pobiera wszystkie tagi z serwera, ale domyślnie tagi się nie wypushowują

Dwa sposoby pushowania tagów

• Zalecany: git push origin tag_name
• Silnie odradzany: git push --tags

Trunk Based Development

Git Flow

Git Guitar Hero

Git blame

Git blame w dobrym IDE jest równie wygodne jak w konsoli

Aliasy

Modyfikacje aliasów można wykonywać w gitconfigu

• [alias]
• st = status
• ci = commit -v

Albo za pomocą polecenia

• git config --global alias.st status
• git config --global alias.ci 'commit -v'

Przykład użycia - skrócone wypisywanie statusu

• git st

Inne przykłady aliasów

• wdiff = diff --word-diff=plain
• rh1 = reset HEAD^ --hard
• amend = commit --amend -aC HEAD
• standup = log --since '1 day ago' --oneline --author krzysztof.morcinek@gmail.com # hack it with your email
• cam = commit -am
• jira = log --since '6am' --oneline --author krzysztof.morcinek@gmail.com # hack it with your email
• ls = log --pretty=format:"%C(yellow)%h%Cred%d\\ %Creset%s%Cgreen\\ [%cn]" --decorate
• mt = mergetool

Wiele remotów

• git remote add anotherOrigin https...
• git remote -v
• git push anotherOrigin
• git fetch anotherOrigin
• git push -u anotherOrigin your_branch

Credentials helper

Wbudowane credentials helpery

• cache
  • git config --global credential.helper 'cache --timeout=300'
    Bezpieczny, ale tylko tymczasowy (in memory).
    Opcjonalnie własny timeout w sekundach (domyślny 900 - 15minut).
• store
  • git config --global credential.helper store
    Wygodny, ale niebezpieczny - credentiale zapisane w pliku tekstowym niezaszyfrowane.

libsecret - wygodny i bezpieczny credentials helper dla Linux

Wygodny i bezpieczny credentials helper dla Windows

Instalator: github.com/Microsoft/Git-Credential-Manager-for-Windows/releases

Lub checkbox w trakcie instalacji gita:

Powinno ustawić: git config --global credential.helper manager
albo ścieżkę do exe

Podpis kryptograficzny

Commity i tagi można podpisywać kryptograficznie, jednak wymaganie tego w workflow jest kłopotliwe

• $ git log --show-signature
commit 5c3386cf54bba0a33a32da706aa52bc0155503c2
gpg: Signature made Wed Jun 4 19:49:17 2014 PDT using RSA key ID 0A46826A
gpg: Good signature from "Scott Chacon (Git signing key) <schacon@gmail.com>"
Author: Scott Chacon <schacon@gmail.com>
Date: Wed Jun 4 19:49:17 2014 -0700
Add new function

Git hooks