Zatwierdzanie plików i wyświetlanie historii

Ukończone

Po zainicjowaniu repozytorium Git możesz rozpocząć dodawanie plików. W tej lekcji dowiesz się, jak poinformować usługę Git o śledzeniu zmian w plikach w repozytorium.

Uwaga

Polecenia w tej lekcji są wyświetlane w celu zilustrowania pojęć. Nie uruchamiaj jeszcze poleceń. Wkrótce dowiesz się, czego nauczysz się tutaj.

Struktura folderów dla repozytorium

Podczas pracy z systemem kontroli wersji, na przykład Git, ważne jest zaplanowanie sposobu przechowywania plików. Dobrym pomysłem jest posiadanie jasnej struktury folderów.

Jeśli tworzysz kod Bicep w celu wdrożenia aplikacji lub innego rozwiązania, warto również przechowywać pliki Bicep w tym samym repozytorium co kod aplikacji i inne pliki. W ten sposób za każdym razem, gdy ktoś musi dodać nową funkcję, która zmienia zarówno kod aplikacji Bicep, jak i kod aplikacji, zostaną one śledzone razem.

Planowanie struktury folderów ułatwia również wdrażanie rozwiązania z potoku. Dowiesz się więcej o tym w przyszłym module.

Różne zespoły mają różne konwencje dotyczące sposobu konfigurowania folderów i plików repozytorium. Nawet jeśli nie pracujesz z zespołem, nadal warto zdecydować się na konwencję do naśladowania. Pomoże to każdemu, kto musi pracować z kodem w przyszłości.

Jeśli twój zespół nie ma jeszcze preferencji, oto sugestia, jak to zrobić:

  • W katalogu głównym repozytorium utwórz plik README.md . W tym pliku markdown (tekst) opisano, co znajduje się w repozytorium i przekazuje instrukcje ułatwiające członkom zespołu konfigurowanie elementów.
  • W katalogu głównym repozytorium utwórz folder deploy . Wewnątrz folderu:
    • Zapisz główny szablon Bicep o nazwie main.bicep.
    • Utwórz podfolder modułów, aby przechowywać moduły Bicep.
    • Jeśli masz inne skrypty lub pliki używane podczas wdrażania, zapisz je w folderze deploy .
  • W katalogu głównym repozytorium utwórz folder src . Służy do przechowywania kodu aplikacji.
  • W katalogu głównym repozytorium utwórz folder docs . Służy do przechowywania dokumentacji rozwiązania.

Oto ilustracja przedstawiająca, jak ta struktura może wyglądać na witrynę internetową twojej firmy w firmie:

Diagram that illustrates a folder hierarchy.

Przygotowywanie zmian

Po wprowadzeniu zmian w pliku lub plikach należy je przygotować . Przemieszczanie informuje usługę Git, że należy wziąć pod uwagę zmiany na tyle ważne, aby zachować. Może to wydawać się niepotrzebnym krokiem, ale przemieszczanie daje dużą elastyczność podczas pracy. Na przykład możesz wprowadzić zmiany w kilku plikach, ale chcesz zachować tylko jeden z nich. Możesz też zachować tylko niektóre zmiany wprowadzone w pliku.

Aby przygotować plik, należy użyć git add polecenia i określić nazwę pliku lub nazwę folderu, który chcesz przygotować. Po wykonaniu tej czynności usługa Git wie, że warto zatwierdzić zmiany. Podczas wykonywania zapytania o stan repozytorium przy użyciu polecenia git statuszobaczysz zmiany etapowe.

Ważne

Po przeprowadzeniu etapu pliku, jeśli wprowadzisz do niego jakiekolwiek dalsze zmiany przed zatwierdzeniem, usługa Git nie zarejestruje tych zmian. Aby usługa Git przechwyciła najnowsze zmiany, należy ponownie przygotować plik.

Załóżmy na przykład, że właśnie utworzono moduł Bicep w celu zdefiniowania konta usługi Azure Cosmos DB. Nosi nazwę cosmos-db.bicep i zapisano ją w folderze deploy/modules . Oto jak można przygotować plik:

git add deploy/modules/cosmos-db.bicep

Możesz również przygotować wszystkie zmiany w repozytorium, uruchamiając to polecenie z folderu głównego repozytorium:

git add .

Zatwierdzanie zmian etapowych

Zatwierdzenie reprezentuje zestaw zmian w co najmniej jednym pliku w repozytorium. Gdy wszystko będzie gotowe do zatwierdzenia przygotowanych zmian, użyj git commit polecenia . Zatwierdzenie zawiera komunikat zatwierdzenia, który jest czytelnym dla człowieka opisem zmian.

Oto przykład pokazujący, jak zatwierdzić przedstawione wcześniej zmiany etapowe:

git commit --message "Add Cosmos DB account definition."

Uwaga

Visual Studio Code może również zatwierdzić repozytorium Git. W przypadku korzystania z integracji z usługą Git w Visual Studio Code, jeśli pliki nie zostały jeszcze przygotowane, Visual Studio Code pyta, czy chcesz przygotować wszystkie zmienione pliki. Można to nawet ustawić jako domyślne zachowanie. Jeśli wolisz, możesz ręcznie przygotować i cofnąć scenę plików przy użyciu kontroli źródła w Visual Studio Code.

Utwórz krótkie komunikaty zatwierdzenia, ale utwórz je opisowo. Gdy ty lub członek zespołu przejdą historię zatwierdzeń w przyszłości, każdy komunikat zatwierdzenia powinien wyjaśnić, jaka była zmiana i dlaczego została ona wprowadzona.

Nie ma żadnych reguł dotyczących tego, jakie komunikaty zatwierdzenia muszą zawierać lub jak są sformatowane. Ale konwencjonalne, są napisane w obecnej napiętej i w pełnym zdaniu, tak jakbyś dał rozkazy bazie kodu.

Porada

Dobrym rozwiązaniem jest pisanie opisowych komunikatów zatwierdzania nawet wtedy, gdy pracujesz samodzielnie. Ktoś inny może potrzebować przyjrzeć się kodowi w przyszłości. Nawet jeśli nie, może być konieczne przejrzenie własnej historii i chcesz ułatwić sobie życie!

Oto kilka przykładów dobrych komunikatów zatwierdzania:

  • Zaktualizuj konfigurację App Service, aby dodać konfigurację sieci.
  • Usuń konto magazynu, ponieważ zostało zastąpione przez bazę danych Cosmos DB.
  • Dodaj definicję zasobów Szczegółowe informacje aplikacji i integruj się z aplikacją funkcji.

Wyświetlanie historii pliku

Po zatwierdzeniach plików w repozytorium Git możesz użyć polecenia interfejsu git log wiersza polecenia, aby wyświetlić historię pliku, a nawet wszystkie zatwierdzenia w repozytorium.

Aby wyświetlić listę zatwierdzeń, uruchom następujące polecenie:

git log --pretty=oneline

Dane wyjściowe tego polecenia zawierają listę zatwierdzeń z najnowszymi zatwierdzeniami. Każdy wiersz zawiera skrót zatwierdzenia, który jest identyfikatorem używanym wewnętrznie przez usługę Git do śledzenia każdego zatwierdzenia. Zawiera również komunikat zatwierdzenia, który jest jednym z powodów, dla których jest tak ważne, aby napisać dobre komunikaty zatwierdzenia.

Często zdarza się również wyświetlanie zatwierdzeń do określonego pliku. Nazwę pliku można określić po uruchomieniu git log polecenia, w następujący sposób:

git log deploy/main.bicep

Interfejs wiersza polecenia git i git log polecenie zawierają wiele argumentów, których można użyć do wyświetlania informacji o zatwierdzeniach i plikach. Jednak często łatwiej jest używać Visual Studio Code do wyświetlania historii zatwierdzń dla pliku.

W okienku eksploratora Visual Studio Code możesz wybrać i wstrzymać (lub kliknąć prawym przyciskiem myszy) plik w repozytorium, a następnie wybrać pozycję Wyświetl oś czasu. Zostanie otwarte okienko Oś czasu i zostanie wyświetlona lista każdego zatwierdzenia, które miało wpływ na ten plik. Po wybraniu zatwierdzenia zobaczysz dokładne zmiany w pliku. W następnym ćwiczeniu zobaczysz, jak używać tych informacji.