Integracja z GitHub

Dzięki integracji z GitHub widzą Państwo pull requesty, przebiegi GitHub Actions, ś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 GitHub

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 pull requesty z identyfikatorem zadania pojawiają się przy właściwym zadaniu.
  • Przebiegi GitHub Actions 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.
  • Nieudane przebiegi uruchamiają Państwo ponownie bezpośrednio z FeatValue.

Przegląd pokazuje strona o integracji z GitHub.

Wymagania

  • konto FeatValue Państwa firmy z co najmniej jednym klientem i projektem (zob. Tworzenie Projektów)
  • konto lub organizacja na github.com
  • uprawnienie do instalowania aplikacji na tym koncie lub w tej organizacji. W organizacjach mają je właściciele (owners). Pozostali członkowie mogą poprosić o instalację, którą właściciel następnie zatwierdza w GitHub.

Połączenie GitHub

  1. Otworzyć aplikację

    Proszę kliknąć Aplikacje w lewym menu bocznym, wybrać GitHub i kliknąć Zainstaluj (zob. Łączenie aplikacji).
  2. Połączyć z GitHub

    Proszę kliknąć Połącz z GitHub. Krótka informacja wymienia uprawnienia, o które prosi aplikacja (zob. Uprawnienia GitHub App). Proszę kliknąć Przejdź do GitHub.
  3. Zalogować się w GitHub

    Proszę zalogować się w GitHub i autoryzować aplikację FeatValue.
  4. Zainstalować aplikację lub wybrać organizacje

    Jeśli aplikacja nie jest jeszcze nigdzie zainstalowana, GitHub od razu otwiera instalację: proszę wybrać swoje konto lub organizację, potem All repositories albo w Only select repositories repozytoria, które FeatValue może widzieć, i kliknąć Install. Jeśli aplikacja jest już zainstalowana w kilku organizacjach, na stronie wyboru wskazują Państwo organizacje do połączenia. Następnie nastąpi powrót do FeatValue.
Proszę nadawać dostęp tylko do repozytoriów, które chcą Państwo połączyć z projektami FeatValue. Wybór można w każdej chwili zmienić w GitHub przy aplikacji FeatValue: na koncie osobistym w Settings › Applications › Installed GitHub Apps, w organizacji w Organization settings › Third-party Access › GitHub Apps.

Uprawnienia GitHub App

Aplikacja FeatValue prosi GitHub o następujące uprawnienia:

  • Metadata: read: nazwy i podstawowe dane udostępnionych repozytoriów
  • Contents: read: commity i porównania gałęzi
  • Pull requests: read: pull requesty z tytułem, statusem i gałęzią
  • Actions: read & write: odczyt przebiegów GitHub Actions, zapis tylko do ponownego uruchomienia przebiegu
  • Deployments: read: wdrożenia i środowiska
GitHub App prosi o dostęp do odczytu zawartości repozytorium (Contents: read), ponieważ GitHub udostępnia commity i porównania gałęzi tylko z tym uprawnieniem. FeatValue odczytuje dzięki temu wyłącznie dane commitów (wiadomość, autor, czas) i porównania gałęzi, nigdy kod źródłowy, i nie zapisuje żadnych plików.

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ć GitHub (zob. Połączone aplikacje w ustawieniach). Strona nazywa się Połącz repozytoria.
  2. Znaleźć repozytorium

    Repozytoria, do których nadali Państwo aplikacji dostęp, są wymienione w Repozytoria w GitHub. 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 uzupełnia dane z ostatnich kilku dni. Nie trzeba tworzyć webhooka, zdarzenia docierają przez aplikację FeatValue.

Wszystkie połączenia są widoczne w Połączone repozytoria. Kolumna Aktualizacja pokazuje Od razu przez webhook. Przyciskiem Zmień wybierają Państwo inny projekt, a przyciskiem Odłącz usuwają połączenie.

Kilka organizacji w jednym połączeniu

Jedno połączenie FeatValue może korzystać z aplikacji we wszystkich organizacjach i kontach GitHub, w których jest zainstalowana i do których mają Państwo dostęp podczas łączenia, na przykład we własnej organizacji i w organizacjach klientów. Lista na stronie Połącz repozytoria jest pogrupowana według organizacji.

  1. Dodać organizację

    Proszę otworzyć Ustawienia › GitHub (strona Połącz repozytoria) i kliknąć Dodaj organizację.
  2. Wybrać organizację

    Proszę wybrać organizację, w której aplikacja jest już zainstalowana. Jeśli jej brakuje, proszę kliknąć Zainstaluj w innej organizacji i zainstalować tam aplikację w GitHub.
  3. Połączyć repozytoria

    Repozytoria organizacji pojawiają się na liście. Proszę je połączyć tak, jak opisano powyżej.

Kilka firm w FeatValue może korzystać z tej samej instalacji, na przykład Państwa agencja i klient z własnym kontem FeatValue.

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 pull 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.
  • Przebiegi GitHub Actions i wdrożenia należą do zadania, jeśli działają dla jednej z jego gałęzi, jednego z commitów lub pull requestów.

Co pojawia się przy zadaniu

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

  • Workflowy: przebiegi GitHub Actions, na przykład CI #57, z ich jobami i statusem
  • Środowiska z Państwa wdrożeń z linkiem do otwarcia, na przykład Staging i Production
  • Pull requesty, Gałęzie i Commity

Co pojawia się w projekcie

W projekcie sekcja Rozwój pokazuje środowiska z ich ostatnim wdrożeniem oraz ostatni przebieg na gałęzi domyślnej. Po kliknięciu Pokaż wszystkie przebiegi workflow widzą Państwo Ostatnie przebiegi workflow. 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 GitHub
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, pull requesty, workflowy, ś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:

  • Pull request scalony
  • Workflow zakończony sukcesem
  • Workflow 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?.

Ponowne uruchamianie nieudanych przebiegów Starter

Gdy przebieg GitHub Actions się nie powiedzie albo zostanie anulowany, uruchamiają go Państwo ponownie bezpośrednio w FeatValue. W przypadku nieudanego przebiegu GitHub uruchamia ponownie tylko nieudane joby, w przypadku anulowanego cały przebieg. Funkcja jest dostępna od planu Starter (zob. Plany).

  1. Zezwolić na workflow

    Proszę otworzyć w projekcie Ustawienia sekcji Rozwój. W Ponowne uruchamianie workflowów z FeatValue znajdą Państwo workflow, dla których GitHub dotąd zgłosił nieudany przebieg, na przykład CI. Proszę zaznaczyć workflow, które mają się pojawiać w FeatValue, i kliknąć Zapisz.
  2. Także dla klientów

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

    Nieudany przebieg dozwolonego workflow pojawia się z przyciskiem Uruchom ponownie. Po kliknięciu FeatValue pokazuje Uruchomiono ponownie, a dalszy przebieg śledzą Państwo przy tym przebiegu.

Bezpieczeństwo

  • Tylko udostępnione i połączone repozytoria: Aplikacja FeatValue widzi tylko repozytoria, do których nadadzą Państwo dostęp podczas instalacji. FeatValue przypisuje identyfikatory zadań tylko w repozytoriach połączonych z projektem i tylko w tym projekcie.
  • Bez kodu źródłowego: FeatValue odczytuje tylko dane commitów i porównania gałęzi, nigdy kod źródłowy, i nie zapisuje plików z Państwa repozytorium. Do tego aplikacja prosi o Contents: read (zob. Uprawnienia GitHub App).
  • Weryfikowane webhooki: GitHub podpisuje każde dostarczenie do FeatValue. FeatValue przyjmuje tylko wywołania z prawidłowym podpisem.
  • Niewiele uprawnień zapisu: Jedyne, co aplikacja może zmieniać, to ponowne uruchamianie przebiegów GitHub Actions, i to tylko dla workflow, na które Państwo zezwolili.
  • Odłączenie w każdej chwili: Odłącz usuwa połączenie. Jeśli odinstalują Państwo aplikację w GitHub, FeatValue automatycznie odłącza repozytoria tej organizacji.

Rozłączenie i odinstalowanie aplikacji

Jeśli rozłączą Państwo GitHub w FeatValue, FeatValue usuwa tylko połączenia repozytoriów. To, co już widać przy zadaniach, pozostaje. Aplikacja pozostaje zainstalowana w GitHub, dopóki nie odinstalują jej Państwo tam:

  • Organizacja: W GitHub proszę otworzyć Organization settings › Third-party Access › GitHub Apps, kliknąć Configure przy aplikacji FeatValue, a na samym dole Uninstall.
  • Konto osobiste: Proszę otworzyć Settings › Applications › Installed GitHub Apps, kliknąć Configure przy aplikacji FeatValue, a potem Uninstall.

Po odinstalowaniu FeatValue automatycznie odłącza repozytoria tej organizacji.

Rozwiązywanie problemów

Mojego repozytorium nie ma na liście

FeatValue pokazuje tylko repozytoria, do których nadali Państwo aplikacji dostęp. Proszę otworzyć w GitHub Settings › Applications › Installed GitHub Apps, wybrać aplikację FeatValue i dodać repozytorium w Repository access. W przypadku organizacji znajdą to Państwo w ustawieniach organizacji.

Instalacja czeka na zatwierdzenie

Jeśli nie są Państwo właścicielem organizacji, GitHub wysyła prośbę o instalację do właścicieli. Gdy tylko właściciel ją zatwierdzi, proszę ponownie połączyć GitHub w FeatValue.

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 pull requeście?
  • Jeśli dostarczenie z GitHub zaginie, FeatValue uzupełnia dane w ciągu 10 minut.

Nie można ponownie uruchomić przebiegu

Ponowne uruchamianie jest dostępne od planu Starter. Workflow musi też być dozwolony w ustawieniach projektu, a przebieg musi być nieudany lub anulowany. Jeśli pojawi się Nie udało się uruchomić ponownie, proszę sprawdzić w GitHub, czy aplikacja jest nadal zainstalowana i może widzieć repozytorium.

Brakuje organizacji na liście wyboru

FeatValue pokazuje tylko organizacje, w których aplikacja jest zainstalowana i do których Państwa konto GitHub ma dostęp. Proszę zainstalować aplikację przez Zainstaluj w innej organizacji albo poprosić o to właściciela organizacji.

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