Med GitHub-integrationen ser du pull requests, körningar i GitHub Actions, miljöer och commits direkt på dina uppgifter i FeatValue. Dina kunder får med enkla ord veta om ändringen pågår, ligger på staging för test eller är live.
Vad GitHub-integrationen är till för
Mjukvaruföretag och webbyråer får hela tiden samma fråga: ”Är det ute nu?” Med integrationen svarar FeatValue på den direkt på uppgiften:
- Grenar, commits och pull requests med uppgiftens ID visas på rätt uppgift.
- Körningar i GitHub Actions och driftsättningar visar om ändringen är testad och vilken miljö den har nått.
- FeatValue skriver viktiga steg som kommentarer i uppgiftens historik.
- För varje projekt bestämmer du vad dina kunder ser av det.
- Du kör om misslyckade körningar direkt från FeatValue.
En översikt finns på sidan om GitHub-integrationen.
Förutsättningar
- ett FeatValue-konto för ditt företag med minst en kund och ett projekt (se Skapa projekt)
- ett konto eller en organisation på github.com
- rätten att installera appar på det här kontot eller den här organisationen. I organisationer är det ägarna (owners). Andra medlemmar kan begära installationen, och en ägare godkänner den sedan i GitHub.
Koppla GitHub
-
Öppna appen
Klicka på
Appar i det vänstra sidofältet, välj
GitHub och klicka på
Installera (se
Anslut appar).
-
Anslut med GitHub
Klicka på
Anslut med GitHub. En kort notis visar vilka behörigheter appen begär (se
Behörigheter för GitHub App). Klicka på
Fortsätt till GitHub.
-
Logga in på GitHub
Logga in på GitHub och auktorisera FeatValue-appen.
-
Installera appen eller välj organisationer
Om appen inte är installerad någonstans än öppnar GitHub installationen direkt: välj ditt konto eller en organisation, sedan All repositories eller under Only select repositories de repositories som FeatValue får se, och klicka på Install. Om appen redan är installerad i flera organisationer väljer du på en valsida vilka organisationer du vill koppla. Sedan kommer du tillbaka till FeatValue.
Ge bara åtkomst till de repositories som du vill koppla till FeatValue-projekt. Du kan ändra urvalet när som helst i GitHub för FeatValue-appen: på ett personligt konto under Settings › Applications › Installed GitHub Apps, i en organisation under Organization settings › Third-party Access › GitHub Apps.
Behörigheter för GitHub App
FeatValue-appen begär följande behörigheter hos GitHub:
- Metadata: read: namn och grunddata för de repositories du ger åtkomst till
- Contents: read: commits och jämförelser mellan grenar
- Pull requests: read: pull requests med titel, status och gren
- Actions: read & write: läsa körningar i GitHub Actions, skriva bara för att starta om en körning
- Deployments: read: driftsättningar och miljöer
GitHub App begär läsåtkomst till innehållet i repositories (Contents: read) eftersom GitHub bara lämnar ut commits och jämförelser mellan grenar med den behörigheten. FeatValue läser bara commitdata (meddelande, författare, tidpunkt) och jämförelser mellan grenar, aldrig källkod, och sparar inga filer.
Koppla ett repository till ett projekt
Varje repository hör till exakt ett FeatValue-projekt. Bara kopplade repositories når FeatValue.
-
Öppna Koppla repositories
Öppna
Inställningar › Företag › Integrationer och appar och välj
GitHub (se
Anslutna appar). Sidan heter
Koppla repositories.
-
Hitta repositoryt
De repositories som du har gett appen åtkomst till listas under Repositories i GitHub. Med Sök repository begränsar du listan.
-
Välj projekt och koppla
Välj FeatValue-projekt bredvid repositoryt och klicka på Koppla. FeatValue hämtar in de senaste dagarna i efterhand. Du behöver inte skapa någon webhook, händelserna kommer via FeatValue-appen.
Alla kopplingar listas under Kopplade repositories. Kolumnen Uppdatering visar Direkt via webhook. Med Ändra väljer du ett annat projekt, och med Koppla från tar du bort kopplingen.
Flera organisationer i en koppling
En koppling i FeatValue kan använda appen från alla GitHub-organisationer och konton där den är installerad och som du har åtkomst till när du kopplar, till exempel din egen organisation och dina kunders organisationer. Listan på sidan Koppla repositories är grupperad efter organisation.
-
Lägg till organisation
Öppna Inställningar › GitHub (sidan Koppla repositories) och klicka på Lägg till organisation.
-
Välj organisation
Välj en organisation där appen redan är installerad. Saknas den klickar du på Installera i en annan organisation och installerar appen där i GitHub.
-
Koppla repositories
Organisationens repositories visas i listan. Koppla dem som beskrivs ovan.
Flera företag i FeatValue får använda samma installation, till exempel din byrå och din kund med ett eget FeatValue-konto.
Så använder du uppgiftens ID rätt
Varje uppgift i FeatValue har ett ID, till exempel abc123-4. Du hittar det på uppgiften. Skriv detta ID på ett av de här ställena:
| Var |
Exempel |
| Grennamn |
abc123-4-kontaktformular |
| Commit-meddelande |
abc123-4 Gör telefonnummer obligatoriskt |
| Titel eller beskrivning av pull requesten |
Kontaktformulär: gör telefonnummer obligatoriskt (abc123-4) |
- Stora och små bokstäver spelar ingen roll, och ett inledande
# är tillåtet.
- Står ID:t i grennamnet räknas bara de commits som enbart finns på den här grenen. Commits från standardgrenen som följer med när du skapar grenen visas inte på uppgiften.
- Commits på andra grenar visas bara om ID:t står i deras commit-meddelande.
- ID:t gäller bara inom det kopplade projektet. FeatValue tilldelar aldrig repositories som är kopplade till ett annat projekt eller inte kopplade alls.
- Körningar i GitHub Actions och driftsättningar hör till uppgiften om de körs för någon av dess grenar, commits eller pull requests.
Det här visas på uppgiften
Uppgiften visar avsnittet Utveckling med en kompakt rad, till exempel: PR #12 sammanfogad · Workflow lyckades · Driftsatt på Staging. Klicka på Visa detaljer för att fälla ut:
- Workflows: körningarna i GitHub Actions, till exempel CI #57, med deras jobb och status
- Miljöer från dina driftsättningar med en länk för att öppna dem, till exempel Staging och Production
- Pull requests, Grenar och Commits
Det här visas i projektet
I projektet visar avsnittet Utveckling miljöerna med deras senaste driftsättning och den senaste körningen på standardgrenen. Klicka på Visa alla workflow-körningar för att se Senaste workflow-körningar. Här hittar du också projektets Inställningar.
Vad ser kunderna?
I Inställningar för avsnittet Utveckling i projektet väljer du under Vad ser kunderna?:
| Inställning |
Din kund ser |
| Inget |
ingen information från GitHub |
| Enkel status |
en mening utan tekniska begrepp: Pågår, Driftsatt på Staging med länken testa här eller Live med länken titta nu |
| Detaljer |
de avsnitt du kryssar i under Detaljer för kunder: commits, grenar, pull requests, workflows, miljöer och historikkommentarer |
Personer i ditt företag som får redigera projektet kan ändra den här inställningen. Hur din kund sedan testar och godkänner förklaras under Granskning och acceptans.
Ställa in historikkommentarer
FeatValue skriver viktiga steg som kommentarer i uppgiftens historik. Under Historikkommentarer på uppgiften väljer du för varje projekt vilka händelser som skapar en kommentar:
- Pull request mergad
- Workflow lyckades
- Workflow misslyckades (med misslyckade jobb)
- Driftsatt i miljö
Avmarkerade händelser uppdaterar fortfarande statusen på uppgiften men skapar ingen kommentar längre. Om din kund ser kommentarerna beror på inställningen under Vad ser kunderna?.
Kör om misslyckade körningar
Starter
När en körning i GitHub Actions misslyckas eller avbryts kör du om den direkt i FeatValue. För en misslyckad körning kör GitHub bara om de misslyckade jobben, för en avbruten körning hela körningen. Det är tillgängligt från Starter-planen (se Planer).
-
Tillåt workflows
Öppna Inställningar för avsnittet Utveckling i projektet. Under Starta om workflows från FeatValue hittar du de workflows som GitHub hittills har rapporterat en misslyckad körning för, till exempel CI. Kryssa i de workflows som ska visas i FeatValue och klicka på Spara.
-
Även för kunder
Om din kund också ska kunna köra om de valda workflows kryssar du i Även kunder får starta om de valda workflows.
-
Kör om
En misslyckad körning av ett tillåtet workflow visas med knappen Starta om. Efter klicket visar FeatValue Omstartad, och resten följer du i körningen.
Säkerhet
- Bara godkända och kopplade repositories: FeatValue-appen ser bara de repositories som du ger åtkomst till vid installationen. FeatValue tilldelar uppgifts-ID:n bara i repositories som du har kopplat till ett projekt, och bara inom det projektet.
- Ingen källkod: FeatValue läser bara commitdata och jämförelser mellan grenar, aldrig källkod, och sparar inga filer från ditt repository. Därför begär appen Contents: read (se Behörigheter för GitHub App).
- Verifierade webhooks: GitHub signerar varje leverans till FeatValue. FeatValue tar bara emot anrop med giltig signatur.
- Få skrivrättigheter: Det enda appen får ändra är att köra om körningar i GitHub Actions, och bara för de workflows som du har tillåtit.
- Koppla från när som helst: Koppla från tar bort en koppling. Om du avinstallerar appen i GitHub kopplar FeatValue automatiskt från den organisationens repositories.
Koppla från och avinstallera appen
Om du kopplar från GitHub i FeatValue tar FeatValue bara bort kopplingarna till repositories. Det som redan visas på uppgifterna finns kvar. Appen är kvar i GitHub tills du avinstallerar den där:
- Organisation: Öppna Organization settings › Third-party Access › GitHub Apps i GitHub, klicka på Configure vid FeatValue-appen och längst ner på Uninstall.
- Personligt konto: Öppna Settings › Applications › Installed GitHub Apps, klicka på Configure vid FeatValue-appen och sedan på Uninstall.
Efter avinstallationen kopplar FeatValue automatiskt från den organisationens repositories.
Felsökning
Mitt repository saknas i listan
FeatValue visar bara repositories som du har gett appen åtkomst till. Öppna Settings › Applications › Installed GitHub Apps i GitHub, välj FeatValue-appen och lägg till repositoryt under Repository access. För en organisation hittar du detta i organisationens inställningar.
Installationen väntar på godkännande
Om du inte är ägare av organisationen skickar GitHub installationsbegäran till ägarna. När en ägare har godkänt den kopplar du GitHub i FeatValue igen.
Inget visas på uppgiften
- Är repositoryt kopplat till det projekt som uppgiften hör till?
- Står hela uppgiftens ID i grennamnet, commit-meddelandet eller pull requesten?
- Om en leverans från GitHub går förlorad hämtar FeatValue in den inom 10 minuter.
En körning går inte att köra om
Att köra om är tillgängligt från Starter-planen. Workflowet måste också vara tillåtet i projektinställningarna, och körningen måste ha misslyckats eller avbrutits. Visas Kunde inte startas om kontrollerar du i GitHub om appen fortfarande är installerad och får se repositoryt.
En organisation saknas i urvalet
FeatValue visar bara organisationer där appen är installerad och som ditt GitHub-konto har åtkomst till. Installera appen via Installera i en annan organisation eller be en ägare av organisationen att göra det.