Integracja z GitLab

Dzięki integracji z GitLab widzą Państwo merge requesty, pipeline’y, środowiska i commity bezpośrednio przy zadaniach w FeatValue. Klienci dowiadują się prostymi słowami, czy ich zmiana jest w realizacji, czeka na stagingu na testy, czy działa już na żywo.

Do czego służy integracja z GitLab

Software house’y i agencje interaktywne wciąż słyszą to samo pytanie: „Czy to już jest online?” Dzięki integracji FeatValue odpowiada na nie w zadaniu:

  • Gałęzie, commity i merge requesty z identyfikatorem zadania pojawiają się przy właściwym zadaniu.
  • Pipeline’y i wdrożenia pokazują, czy zmiana została przetestowana i na które środowisko trafiła.
  • FeatValue zapisuje ważne kroki jako komentarze w historii zadania.
  • Dla każdego projektu decydują Państwo, co z tego widzą klienci.
  • Ręczne joby, na przykład wdrożenie, uruchamiają Państwo bezpośrednio z FeatValue.

Przegląd pokazuje strona o integracji z GitLab.

Wymagania

  • konto FeatValue Państwa firmy z co najmniej jednym klientem i projektem (zob. Tworzenie Projektów)
  • GitLab na gitlab.com lub jako własna instancja, dostępny przez https
  • co najmniej rola Maintainer w projektach GitLab, które chcą Państwo połączyć. Dzięki niej FeatValue może utworzyć webhook.

Połączenie GitLab

  1. Otworzyć aplikację

    Proszę kliknąć Aplikacje w lewym menu bocznym, wybrać GitLab i kliknąć Zainstaluj (zob. Łączenie aplikacji). Pojawi się strona Połącz GitLab z pytaniem Gdzie działa Twój GitLab?
  2. gitlab.com

    Proszę wybrać gitlab.com i kliknąć Dalej, a następnie zalogować się w GitLab i zezwolić na dostęp. W ten sposób FeatValue uzyskuje dostęp do Państwa projektów.
  3. Własna instancja GitLab

    Proszę wybrać Własna instancja GitLab. W polu Adres instancji proszę wpisać adres https, na przykład https://gitlab.example.com, a w polu Personal access token token. Następnie proszę kliknąć Dalej.

Jakiego tokenu potrzebuję dla własnej instancji?

Token tworzą Państwo w GitLab w Preferencje › Access tokens:

  • Zakres: api. Zakresy tylko do odczytu, takie jak read_api, nie wystarczą, ponieważ FeatValue tworzy webhooki i uruchamia ręczne joby.
  • Rola: Użytkownik tokenu potrzebuje w projektach co najmniej roli Maintainer.
  • Data wygaśnięcia: Po wygaśnięciu tokenu nie docierają już nowe dane. Wtedy proszę utworzyć nowy token i ponownie połączyć GitLab.
Najlepiej używać do integracji osobnego użytkownika albo tokenu grupy. Dzięki temu integracja nie zależy od konta jednej osoby.

Połączenie repozytorium z projektem

Każde repozytorium należy do dokładnie jednego projektu FeatValue. Do FeatValue trafiają tylko połączone repozytoria.

  1. Otworzyć Połącz repozytoria

    Proszę otworzyć Ustawienia › Firma › Integracje i aplikacje i wybrać GitLab (zob. Połączone aplikacje w ustawieniach). Strona nazywa się Połącz repozytoria.
  2. Znaleźć repozytorium

    Państwa repozytoria są wymienione w Repozytoria w GitLab. Polem Szukaj repozytorium mogą Państwo zawęzić listę.
  3. Wybrać projekt i połączyć

    Obok repozytorium proszę wybrać Projekt FeatValue i kliknąć Połącz. FeatValue tworzy webhook w GitLab i uzupełnia dane z ostatnich kilku dni.

Wszystkie połączenia są widoczne w Połączone repozytoria. Kolumna Aktualizacja pokazuje Od razu przez webhook albo Co 10 minut. Przyciskiem Zmień wybierają Państwo inny projekt, a przyciskiem Odłącz usuwają połączenie; FeatValue usuwa wtedy również webhook.

Prawidłowe użycie identyfikatora zadania

Każde zadanie w FeatValue ma identyfikator, na przykład abc123-4. Znajdą go Państwo przy zadaniu. Proszę wpisać ten identyfikator w jednym z tych miejsc:

Gdzie Przykład
Nazwa gałęzi abc123-4-formularz-kontaktowy
Wiadomość commita abc123-4 Numer telefonu jako pole obowiązkowe
Tytuł lub opis merge requestu Formularz kontaktowy: numer telefonu obowiązkowy (abc123-4)
  • Wielkość liter nie ma znaczenia, a znak # na początku jest dozwolony.
  • Jeśli identyfikator jest w nazwie gałęzi, liczą się tylko commity, które istnieją wyłącznie na tej gałęzi. Commity z gałęzi domyślnej, które trafiły do niej przy odgałęzieniu, nie pojawiają się przy zadaniu.
  • Commity na innych gałęziach pojawiają się tylko wtedy, gdy identyfikator jest w ich wiadomości commita.
  • Identyfikator obowiązuje tylko w połączonym projekcie. FeatValue nigdy nie przypisuje repozytoriów połączonych z innym projektem ani niepołączonych wcale.
  • Pipeline’y i wdrożenia należą do zadania, jeśli działają dla jednej z jego gałęzi, jednego z commitów lub merge requestów.

Co pojawia się przy zadaniu

Zadanie pokazuje sekcję Rozwój z jedną zwięzłą linią, na przykład: MR !12 scalony · Pipeline zakończony sukcesem · Wdrożono na Staging. Po kliknięciu Pokaż szczegóły sekcja się rozwija:

  • Pipeline’y z etapami i jobami oraz ich statusem
  • Środowiska z linkiem do otwarcia, na przykład Staging i Production
  • Merge requesty, Gałęzie i Commity

Co pojawia się w projekcie

W projekcie sekcja Rozwój pokazuje środowiska z ich ostatnim wdrożeniem oraz ostatni pipeline na gałęzi domyślnej. Po kliknięciu Pokaż wszystkie pipeline'y widzą Państwo Ostatnie pipeline'y. Tu znajdują się też Ustawienia projektu.

Co widzą klienci?

W projekcie, w Ustawieniach sekcji Rozwój, proszę wybrać w Co widzą klienci?:

Ustawienie Klient widzi
Nic żadnych informacji z GitLab
Prosty status jedno zdanie bez terminów technicznych: W realizacji, Wdrożono na Staging z linkiem przetestuj tutaj albo Na żywo z linkiem zobacz teraz
Szczegóły sekcje zaznaczone w Szczegóły dla klientów: commity, gałęzie, merge requesty, pipeline’y, środowiska i komentarze historii

To ustawienie mogą zmieniać osoby z Państwa firmy, które mogą edytować projekt. Jak klient potem testuje i akceptuje, opisuje strona Recenzja i akceptacja.

Konfiguracja komentarzy historii

FeatValue zapisuje ważne kroki jako komentarze w historii zadania. W Komentarze historii przy zadaniu wybierają Państwo dla każdego projektu, które zdarzenia tworzą komentarz:

  • Merge request scalony
  • Pipeline zakończony sukcesem
  • Pipeline nieudany (z nieudanymi jobami)
  • Wdrożono na środowisko

Odznaczone zdarzenia nadal aktualizują status przy zadaniu, ale nie tworzą już komentarza. To, czy klient widzi komentarze, zależy od ustawienia w Co widzą klienci?.

Uruchamianie jobów z FeatValue Starter

Ręczne joby z pipeline’u, na przykład deploy-production, uruchamiają Państwo bezpośrednio w FeatValue. Funkcja jest dostępna od planu Starter (zob. Plany).

  1. Zezwolić na joby

    Proszę otworzyć w projekcie Ustawienia sekcji Rozwój. W Uruchamianie jobów z FeatValue znajdą Państwo ręczne joby, które GitLab dotąd zgłosił. Proszę zaznaczyć joby, które mają się pojawiać w FeatValue, i kliknąć Zapisz.
  2. Także dla klientów

    Jeśli klient ma móc uruchamiać wybrane joby, proszę zaznaczyć Klienci również mogą uruchamiać wybrane joby.
  3. Uruchomić job

    Gdy dozwolony job czeka na ręczne uruchomienie, pojawia się z przyciskiem Uruchom. Po kliknięciu FeatValue pokazuje Uruchomiono, a dalszy przebieg śledzą Państwo w pipeline.
Jeśli widnieje komunikat Nie zgłoszono jeszcze ręcznych jobów., nie działał jeszcze żaden pipeline z ręcznym jobem. Gdy tylko GitLab go zgłosi, mogą Państwo na niego zezwolić.

Bezpieczeństwo

  • Tylko połączone repozytoria: FeatValue odczytuje tylko repozytoria, które połączyli Państwo z projektem, i przypisuje identyfikatory zadań tylko w tym projekcie.
  • Bez kodu: FeatValue nie zapisuje plików z Państwa repozytorium, tylko informacje o gałęziach, commitach, merge requestach, pipeline’ach i środowiskach.
  • Weryfikowany webhook: Każdy webhook otrzymuje własny tajny token. FeatValue przyjmuje tylko wywołania, które przesyłają ten token.
  • Państwa uprawnienia w GitLab: FeatValue działa z uprawnieniami logowania lub tokenu. Może uruchamiać tylko joby, na które Państwo zezwolili.
  • Odłączenie w każdej chwili: Odłącz usuwa połączenie, a FeatValue usuwa webhook.

Rozwiązywanie problemów

Mojego repozytorium nie ma na liście

FeatValue pokazuje tylko repozytoria, w których mają Państwo co najmniej rolę Maintainer. Proszę sprawdzić swoją rolę w GitLab albo wyszukać nazwę polem Szukaj repozytorium.

Nie udało się utworzyć webhooka

Połączenie pokazuje wtedy Co 10 minut zamiast Od razu przez webhook. W takim przypadku FeatValue sprawdza GitLab co 10 minut, więc nic nie ginie, dane docierają tylko później. Częste przyczyny: brak roli Maintainer albo Państwa instancja GitLab nie może wysyłać żądań do internetu. Proszę to sprawdzić, a następnie kliknąć Zmień i ponownie Połącz.

Przy zadaniu nic się nie pojawia

  • Czy repozytorium jest połączone z projektem, do którego należy zadanie?
  • Czy pełny identyfikator zadania jest w nazwie gałęzi, wiadomości commita lub merge requeście?
  • Bez webhooka nowe dane docierają po maksymalnie 10 minutach.

GitLab nie przyjął tokenu

Proszę sprawdzić adres instancji, token i zakres api. Token nie może być wygasły.

Nie można uruchomić joba

Uruchamianie jobów jest dostępne od planu Starter. Job musi też być dozwolony w ustawieniach projektu i właśnie czekać na ręczne uruchomienie. Jeśli pojawi się Nie udało się uruchomić, proszę sprawdzić w GitLab, czy logowanie nadal może uruchamiać ten job.

Your question has not been answered?

We will be happy to help you. You can send us an e-mail or arrange a video conference:

Privacy Policy • Informacje prawne • Terms and Conditions