Med GitLab-integrationen ser du merge requests, pipelines, 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 GitLab-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 merge requests med uppgiftens ID visas på rätt uppgift.
- Pipelines 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 startar manuella jobb, till exempel en driftsättning, direkt från FeatValue.
En översikt finns på sidan om GitLab-integrationen.
Förutsättningar
- ett FeatValue-konto för ditt företag med minst en kund och ett projekt (se Skapa projekt)
- GitLab på gitlab.com eller som egen instans, nåbar via https
- minst rollen Maintainer i de GitLab-projekt som du vill koppla. Då kan FeatValue skapa webhooken.
Koppla GitLab
-
Öppna appen
Klicka på
Appar i det vänstra sidofältet, välj
GitLab och klicka på
Installera (se
Anslut appar). Sidan
Koppla GitLab visas med frågan
Var finns ditt GitLab?
-
gitlab.com
Välj gitlab.com och klicka på Fortsätt. Logga in på GitLab och tillåt åtkomsten. Då får FeatValue åtkomst till dina projekt.
-
Egen GitLab-instans
Välj Egen GitLab-instans. Ange https-adressen under Instansens adress, till exempel https://gitlab.example.com, och en token under Personal access token. Klicka på Fortsätt.
Vilken token behöver jag för en egen instans?
Skapa token i GitLab under Inställningar › Access tokens:
- Scope:
api. Skrivskyddade scopes som read_api räcker inte, eftersom FeatValue skapar webhooks och startar manuella jobb.
- Roll: Användaren som äger token behöver minst rollen Maintainer i projekten.
- Utgångsdatum: När token har gått ut kommer inga nya data. Skapa en ny och koppla GitLab igen.
Använd helst en egen användare eller en grupptoken för integrationen. Då är den inte beroende av en enskild persons konto.
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
GitLab (se
Anslutna appar). Sidan heter
Koppla repositories.
-
Hitta repositoryt
Dina repositories listas under Repositories i GitLab. Med Sök repository begränsar du listan.
-
Välj projekt och koppla
Välj FeatValue-projekt bredvid repositoryt och klicka på Koppla. FeatValue skapar en webhook i GitLab och hämtar in de senaste dagarna i efterhand.
Alla kopplingar listas under Kopplade repositories. Kolumnen Uppdatering visar Direkt via webhook eller Var tionde minut. Med Ändra väljer du ett annat projekt, och med Koppla från tar du bort kopplingen; FeatValue tar då också bort webhooken.
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 merge 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.
- Pipelines och driftsättningar hör till uppgiften om de körs för någon av dess grenar, commits eller merge requests.
Det här visas på uppgiften
Uppgiften visar avsnittet Utveckling med en kompakt rad, till exempel: MR !12 sammanfogad · Pipeline lyckades · Driftsatt på Staging. Klicka på Visa detaljer för att fälla ut:
- Pipelines med steg och jobb och deras status
- Miljöer med en länk för att öppna dem, till exempel Staging och Production
- Merge 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 pipelinen på standardgrenen. Klicka på Visa alla pipelines för att se Senaste pipelines. 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 GitLab |
| 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, merge requests, pipelines, 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:
- Merge request sammanslagen
- Pipeline lyckades
- Pipeline 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?.
Starta jobb från FeatValue
Starter
Du startar manuella jobb i din pipeline, till exempel deploy-production, direkt i FeatValue. Det är tillgängligt från Starter-planen (se Planer).
-
Tillåt jobb
Öppna Inställningar för avsnittet Utveckling i projektet. Under Starta jobb från FeatValue hittar du de manuella jobb som GitLab har rapporterat hittills. Kryssa i de jobb som ska visas i FeatValue och klicka på Spara.
-
Även för kunder
Om din kund också ska kunna starta de valda jobben kryssar du i Även kunder får starta de valda jobben.
-
Starta ett jobb
När ett tillåtet jobb väntar på manuell start visas det med knappen Starta. Efter klicket visar FeatValue Startad, och resten följer du i pipelinen.
Står det Inga manuella jobb rapporterade ännu. har ingen pipeline med ett manuellt jobb körts än. Så fort GitLab rapporterar ett kan du tillåta det.
Säkerhet
- Bara kopplade repositories: FeatValue läser bara repositories som du har kopplat till ett projekt, och tilldelar uppgifts-ID:n bara inom det projektet.
- Ingen kod: FeatValue sparar inga filer från ditt repository, bara information om grenar, commits, merge requests, pipelines och miljöer.
- Verifierad webhook: Varje webhook får en egen hemlig token. FeatValue tar bara emot anrop som skickar denna token.
- Dina rättigheter i GitLab: FeatValue arbetar med rättigheterna från inloggningen eller token. Den kan bara starta jobb som du har tillåtit.
- Koppla från när som helst: Koppla från tar bort en koppling, och FeatValue tar bort webhooken.
Felsökning
Mitt repository saknas i listan
FeatValue visar bara repositories där du har minst rollen Maintainer. Kontrollera din roll i GitLab eller sök efter namnet med Sök repository.
Webhooken kunde inte skapas
Kopplingen visar då Var tionde minut i stället för Direkt via webhook. I så fall kontrollerar FeatValue GitLab var tionde minut, så inget går förlorat, det kommer bara fram senare. Vanliga orsaker: du saknar rollen Maintainer, eller din GitLab-instans får inte skicka anrop ut på internet. Kontrollera det och klicka sedan på Ändra och Koppla 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 merge requesten?
- Utan webhook tar det upp till 10 minuter innan nya data kommer fram.
GitLab accepterade inte token
Kontrollera instansens adress, token och scope api. Token får inte ha gått ut.
Ett jobb går inte att starta
Att starta jobb är tillgängligt från Starter-planen. Jobbet måste också vara tillåtet i projektinställningarna och just nu vänta på manuell start. Visas Kunde inte startas kontrollerar du i GitLab om inloggningen fortfarande får starta jobbet.