git krótki przewodnik Spis treści Podstawy pracy z systemem git (pojęcia)... 2 Instalacja klienta git Atlassian SourceTree... 2 Konfiguracja Atlassian SourceTree do współpracy z bitbucket.org... 3 Tworzenie nowego repozytorium na bitbucket.org... 6 Dodawanie nowego repozytorium do klienta SourceTree... 7 Inicjowanie pustego repozytorium... 8 Michał Król Koło Naukowe Systemów Informatycznych E-xpert 2014
Podstawy pracy z systemem git (pojęcia) Branch System git pozwala na podział projektu na gałęzie, w celu ułatwienia pracy dla jednej lub wielu osób nad różnymi wersjami projektu. Główna gałąź, przechowująca aktualną (stabilną) wersję projektu jest nazywana master. Każda gałąź może być rozwijana niezależnie, jednak ostatecznie poszczególne zmiany z różnych gałęzi powinny zostać dołączone do gałęzi głównej (master). Można również wykorzystywać git liniowo, wprowadzając zmiany tylko do gałęzi master. Commit Wszelkie zmiany w naszym projekcie organizujemy w commity. Commit to lista zmian dokonanych przez nas na plikach roboczych naszego projektu. Może on zmieniać lub tworzyć jeden lub wiele plików. Zaleca się, aby pojedynczy commit realizował jedną funkcję w naszym projekcie lub naprawiał pojedynczy błąd, co pozwoli na łatwe wycofanie zmian, jeśli zajdzie taka potrzeba. Zasada ta nie jest zawsze przestrzegana. Push Wysłanie (dosłownie wypchnięcie ) naszej listy zmian na serwer zdalny. Pull Ściągnięcie listy zmian zapisanej na serwerze zdalnym do naszej lokalnej kopii repozytorium. Merge Połączenie zmian z jednej gałęzi do innej gałęzi, najczęściej z gałęzi testowych do master. Instalacja klienta git Atlassian SourceTree Atlassian SourceTree to darmowy (wymagający darmowej rejestracji po 30 dniach) klient git, który w odróżnieniu od standardowej wersji gita posiada interfejs graficzny, dlatego jest zalecany dla początkujących użytkowników. Klienta należy pobrać ze strony http://www.sourcetreeapp.com/ Podczas instalacji należy wybrać automatyczną instalację gita wersja wbudowana (embedded). Mercucial nie jest potrzebny. Podczas instalacji nie wczytujemy, ani nie tworzymy kluczy SSH, zrobimy to podczas konfiguracji klienta. 2
Konfiguracja Atlassian SourceTree do współpracy z bitbucket.org Na początek musimy utworzyć klucze SSH, które są wykorzystywane do autoryzacji przy połączeniu z serwerem bitbucket.org. Wybieramy z menu Tools opcję Create or Import SSH Keys. W oknie, które się ukaże wybieramy Generate. Należy zgodnie z instrukcją na ekranie musimy poruszać myszką nad pustym obszarem w oknie, aż zapełnimy pasek postępu. Po wygenerowaniu należy ustawić passphrase hasło potrzebne do używania klucza oraz zapisać klucz prywatny na dysku będzie on nam potrzebny w programie SourceTree. UWAGA: Każdy kto uzyska dostęp do naszego pliku z kluczem prywatnym (oraz hasła - passphrase), będzie miał również dostęp do naszego repozytorium git na serwerze bitbucket.org, zgodnie z ustawieniami naszego konta na serwerze, nawet jeśli nie zna hasła, które używamy do logowania się na stronie. Klucz prywatny należy chronić oraz nie udostępniać nikomu(!). Zawartość pola Public key kopiujemy do schowka, będziemy musieli go dodać w ustawieniach konta na serwerze bitbucket.org, aby móc go wykorzystać do autoryzacji. 3
UWAGA: Klucz publiczny jest informacją mniej wrażliwą niż klucz prywatny pozwala tylko na sprawdzenie, czy przedstawiony przez użytkownika klucz prywatny jest autentyczny, jednak nie należy go udostępniać w celach innych niż konfiguracja dostępu do serwera. Logujemy się na swoje konto bitbucket.org na stronie https://bitbucket.org/account/signin/ Z menu użytkownika wybieramy Manage account, następnie z menu po lewej SSH keys. Na ekranie widzimy listę wszystkich kluczy SSH, które mogą służyć do autoryzacji podczas połączenia z serwerem. Najlepiej utworzyć osobny klucz dla każdego komputera, z którego pracujemy, aby łatwo opanować sytuację, jeśli nasz klucz wycieknie lub zostanie skradziony. Klikamy Add key, aby dodać właśnie utworzony klucz. W odpowiednim polu wklejamy klucz publiczny, który przed chwilą wygenerowaliśmy. Jako etykietę najczęściej podaje się dane w formie nazwa_użytkownika@nazwa_hosta, jednak możemy tam wpisać dowolną treść. 4
Po zapisaniu klucza na dysku oraz dodaniu go na stronie bitbucket.org możemy zamknąć program do generowania kluczy. W kliencie SourceTree wybieramy z menu Tools pozycję Options. W zakładce General musimy uzupełnić swoje dane oraz załadować klucz SSH. 5
Tworzenie nowego repozytorium na bitbucket.org Po zalogowaniu na stronie bitbucket.org z menu Repositories wybieramy Create repository. Wybieramy nazwę dla naszego repozytorium oraz ustawiamy podstawowe opcje: Poziom dostępu (Access level) oznaczamy repozytorium jako prywatne Typ repozytorium (Repository type) Git W miarę potrzeb możemy też zaznaczyć opcje dotyczące zarządzania projektem (Project management), aby utworzyć dla projektu stronę umożliwiającą użytkownikom oraz programistom zgłaszanie oraz śledzenie postępu prac na wyeliminowaniem błędów (Issue tracking) oraz stronę z dokumentacją (Wiki) oraz uzupełnić pozostałe pola. Po uzupełnieniu wszystkich wymaganych informacji klikamy Create repository. Zostaniemy przeniesieni na stronę podsumowania repozytorium. Klikamy przycisk Clone, upewniamy się, że jako protokół wybrany jest SSH oraz kopiujemy adres z pola obok (będzie on potrzebny w kliencie SourceTree). 6
Dodawanie nowego repozytorium do klienta SourceTree Wybieramy z menu File opcję Clone / New. W polu Source Path / URL podajemy URL uzyskany ze strony bitbucket.org (opcja clone na stronie podsumowania projektu, potrzebny jest nam tylko adres po komendzie git clone). W polu Destination Path wybieramy docelowy katalog roboczy dla lokalnej kopii naszego repozytorium git. Klikamy Clone. Możemy już przystąpić do pracy na plikach w naszym repozytorium. UWAGA: należy pamiętać, aby nie usuwać oraz nie modyfikować zawartości (ukrytego) katalogu.git w katalogu roboczym naszego projektu. Szybki dostęp do naszego katalogu roboczego uzyskamy wybierając Show in Explorer z menu kontekstowego listy zmian. 7
Inicjowanie pustego repozytorium Po utworzeniu nowego repozytorium na stronie bitbucket.org oraz dodaniu go do programu SourceTree należy zainicjować nowe repozytorium dodając do niego pierwszy plik/pliki. Najczęściej jako pierwszy dodaje się plik readme, który jest widoczny na stronie podsumowania projektu (zgodnie z uprawnieniami do samego projektu, w przypadku repozytorium prywatnego). Tworzymy w naszym katalogu roboczym plik readme.md w formacie markdown language, używanym do tworzenia dokumentacji. SourcTree prezentuje nam listę zmienionych plików oraz daje możliwość dodania ich do aktualnej listy zmian (commit). 8
Wybieramy plik readme.md z listy zmodyfikowanych plików (Working Copy Changes) oraz klikamy Stage File, aby dodać wszystkie zmiany w danym pliku do naszego commitu. Zmiany na plikach, które przeznaczy liśmy do aktualnego commitu widzimy na liście Staged Changes. Klikamy przycisk Commit w górnym menu, aby przejść do tworzenia listy zmian. Należy uzupełnić pole Commit message, będące opisem słownym wprowadzanych przez nas zmian. Dobrze jest, aby osoba przeglądająca listę zmian mogła łatwo zinterpretować dlaczego zmiany zostały wprowadzone na podstawie tylko opisu zmian. 9
Klikamy przycisk Commit, aby utworzyć listę zmian. Wybierając na dole zakładkę Log / History możemy przejrzeć listę zmian wprowadzonych do naszego repozytorium. Wprowadzone zmiany są na razie przechowywane tylko w naszym lokalnym repozytorium. Aby dodać je do zdalnego repozytorium na serwerze bitbucket.org klikamy przycisk Push. W oknie zaznaczamy, że chcemy wysłać na serwer zmiany z gałęzi głównej naszego projektu (master) lub po prostu zaznaczamy pole Select All, aby wysłać zmiany ze wszystkich gałęzi. Klikamy OK, aby potwierdzić akcję. Zobaczymy okienko przedstawiające postęp bieżącej operacji. Możemy wybrać Show Full Output, aby zobaczyć szczegółowy status operacji. 10
Jeśli operacja została zakończona pomyślnie, to na stronie podsumowania naszego projektu zobaczymy wysłany właśnie przez nas plik readme.md, oczywiście jest on odpowiednio przetworzony na HTML. 11