Ćwiczenie — dodawanie wskaźnika kompilacji

  • 7 min

Ważne jest, aby członkowie zespołu wiedzieli o stanie kompilacji. Łatwym sposobem szybkiego określenia stanu kompilacji jest dodanie wskaźnika kompilacji do pliku README.md w usłudze GitHub. Zaewidencjonujmy zespół, aby zobaczyć, jak to działa.

Andy siedzi przy biurku i czyta pocztę. Odpowiada na trzecią wiadomość e-mail powiązaną ze stanem kompilacji witryny internetowej Space Game .

Andy: Konieczne jest zautomatyzowanie komunikatu o stanie. Dzięki potokowi możemy umieścić je w określonym miejscu. Może Mara wie, jak to zrobić.

Andy spotyka Marę i Amitę rozmawiające w pokoju socjalnym.

Andy: Cześć, Amita. Czy mogę przez chwilę porozmawiać z Marą?

Amita: Muszę dostać się na spotkanie tak. Rozmawiajcie do woli.

Mara: Cześć Andy. Co nowego?

Andy: Bardzo podobają mi się zmiany wprowadzone w potoku kompilacji przy użyciu usługi Azure Pipelines, a usługa Git to świetny system kontroli wersji. Zastanawiałem się, czy istnieje sposób, aby poinformować ludzi o stanie kompilacji?

Mara: Tak, rzeczywiście. Możemy użyć wskaźnika kompilacji.

Co to jest?

Znaczek jest częścią usługi Microsoft Azure Pipelines. Umożliwia dodanie obrazu SVG wskazującego stan kompilacji w repozytorium GitHub.

Większość repozytoriów GitHub zawiera plik o nazwie README.md, który jest plikiem markdown zawierającym podstawowe szczegóły i dokumentację projektu. Usługa GitHub renderuje ten plik na stronie głównej projektu.

Oto przykładowy wskaźnik kompilacji:

Zrzut ekranu usługi GitHub przedstawiający znaczek kompilacji. Stan pokazuje, że najnowsza kompilacja zakończyła się pomyślnie.

W tym ćwiczeniu utworzysz wskaźnik kompilacji widoczny dla wszystkich użytkowników. Może to nie być dobry pomysł dla projektów prywatnych, ponieważ informacje o kompilacji zostaną udostępnione publicznie.

Aby sprawdzić, czy wskaźnik kompilacji jest widoczny:

  1. W usłudze Azure DevOps przejdź do swojej organizacji.

  2. Wybierz pozycję Ustawienia organizacji w dolnym rogu.

  3. W obszarze Potoki wybierz pozycję Ustawienia.

  4. Wyłącz opcję Wyłącz anonimowy dostęp do znaczków.

    Zrzut ekranu usługi Azure DevOps przedstawiający sposób wyłączania anonimowego dostępu do znaczków.

Musisz wprowadzić podobną zmianę w projekcie:

  1. Przejdź do projektu.
  2. Przejdź do obszaru Ustawienia projektu w dolnym rogu.
  3. W obszarze Potoki wybierz pozycję Ustawienia.
  4. Wyłącz opcję Wyłącz anonimowy dostęp do znaczków.

Dodawanie wskaźnika kompilacji

Dotychczas tworzyliśmy lokalne gałęzie systemu Git, aby wprowadzać zmiany w projekcie Space Game. Zmiany można również proponować bezpośrednio w usłudze GitHub. W tej sekcji należy to zrobić, aby skonfigurować wskaźnik stanu.

  1. W usłudze Azure DevOps w okienku po lewej stronie wybierz pozycję Potoki, a następnie wybierz potok.

  2. Wybierz wielokropek (...) w prawym górnym rogu, a następnie wybierz pozycję Znaczek Stan.

    Zrzut ekranu usługi Azure Pipelines przedstawiający menu opcji ustawiania wskaźnika kompilacji.

  3. W obszarze Przykładowy kod Markdown wybierz przycisk Kopiuj , aby skopiować kod Markdown do schowka.

  4. W usłudze GitHub przejdź do projektu.

  5. Upewnij się, że korzystasz z gałęzi main. W obszarze pliki otwórz plik README.md .

  6. Wybierz pozycję Edytuj ten plik (ikona ołówka), aby otworzyć plik w edytorze.

  7. W górnej części strony dodaj pusty wiersz, a następnie wklej zawartość schowka.

  8. Wybierz kartę Podgląd, aby wyświetlić proponowane zmiany.

    Usługa GitHub utworzy plik Markdown ii wyświetli wskaźnik kompilacji.

    Zrzut ekranu usługi GitHub przedstawiający podgląd wskaźnika kompilacji.

Zatwierdź zmiany na głównej

W tej sekcji zatwierdzsz zmiany w gałęzi w usłudze main GitHub.

  1. Wybierz pozycję Zatwierdź zmiany.

  2. W obszarze Komunikat zatwierdzenia określ komunikat zatwierdzenia, taki jak "Dodaj wskaźnik kompilacji".

    Zrzut ekranu witryny GitHub przedstawiający komunikat zatwierdzenia.

  3. Pozostaw wybraną opcję Zatwierdź bezpośrednio w main gałęzi , a następnie wybierz pozycję Zatwierdź zmiany , aby zatwierdzić zmiany w main gałęzi.

    Wskaźnik jest wyświetlany na stronie README.md .

    Zrzut ekranu przedstawiający końcowy wskaźnik kompilacji wyświetlany na stronie README.

    Ta procedura dotyczy bardziej podstawowego sposobu scalania kodu w usłudze GitHub. Zamiast bezpośrednio zatwierdzać zmiany, można utworzyć żądanie ściągnięcia zawierające zmiany, które zostaną sprawdzone przez inne osoby.

    W praktyce należy przełączyć się do main gałęzi i ściągnąć najnowsze zmiany z usługi GitHub przy następnym dodaniu funkcji lub usunąć usterkę.

Andy: Mara, właśnie wprowadzono zmianę bezpośrednio na main. Dlaczego nie użyłaś przepływu, który mi wcześniej pokazałaś? Tego z gałęziami funkcji.

Mara: Moglibyśmy to zrobić. Ale czasami, gdy ludzie zmieniają tylko plik README lub inne pliki dokumentacji, zatwierdzają main się w odpowiednim momencie. Oprócz tego wcześniej wspólnie zweryfikowaliśmy zmiany przed ich scaleniem.

Ale ta myśl prowadzi nas do słusznej konkluzji. Jeśli możemy tylko zatwierdzić main , kiedy chcemy, możemy pozwolić, aby problemy w kodzie wpadły do naszej main gałęzi.

Andy: Mam znaczenie, aby porozmawiać z tobą o tym.

Andy i Mara kontynuują rozmowę, wracając do biurek.