Met de GitLab-integratie ziet u merge requests, pipelines, omgevingen en commits direct bij uw taken in FeatValue. Uw klanten lezen in gewone taal of hun wijziging in uitvoering is, op staging klaarstaat om te testen of live staat.
Waarvoor de GitLab-integratie dient
Softwarebedrijven en webbureaus krijgen steeds dezelfde vraag: “Staat het al online?” Met de integratie beantwoordt FeatValue die vraag bij de taak:
- Branches, commits en merge requests met de taak-ID verschijnen bij de juiste taak.
- Pipelines en deployments tonen of de wijziging getest is en welke omgeving ze heeft bereikt.
- FeatValue zet belangrijke stappen als opmerking in het verloop van de taak.
- Per project bepaalt u wat uw klanten daarvan zien.
- Handmatige jobs, zoals een deployment, start u direct vanuit FeatValue.
Een overzicht vindt u op de pagina over de GitLab-integratie.
Vereisten
- een FeatValue-account van uw bedrijf met minstens één klant en project (zie Projecten aanmaken)
- GitLab op gitlab.com of als eigen instantie, bereikbaar via https
- minstens de rol Maintainer in de GitLab-projecten die u wilt koppelen. Daarmee kan FeatValue de webhook aanmaken.
GitLab koppelen
-
App openen
Klik in de linker zijbalk op
Apps, kies
GitLab en klik op
Installeren (zie
Apps koppelen). De pagina
GitLab koppelen verschijnt met de vraag
Waar staat uw GitLab?
-
gitlab.com
Kies gitlab.com en klik op Verder. Meld u aan bij GitLab en sta de toegang toe. Zo krijgt FeatValue toegang tot uw projecten.
-
Eigen GitLab-instantie
Kies Eigen GitLab-instantie. Vul onder Adres van de instantie het https-adres in, bijvoorbeeld https://gitlab.example.com, en onder Personal access token een token. Klik op Verder.
Welk token heb ik nodig voor een eigen instantie?
Maak het token in GitLab aan onder Voorkeuren › Access tokens:
- Scope:
api. Alleen-lezen scopes zoals read_api zijn niet genoeg, omdat FeatValue webhooks aanmaakt en handmatige jobs start.
- Rol: De gebruiker van het token heeft in de projecten minstens de rol Maintainer nodig.
- Vervaldatum: Zodra het token verloopt, komen er geen nieuwe gegevens meer binnen. Maak dan een nieuw token aan en koppel GitLab opnieuw.
Gebruik voor de integratie bij voorkeur een eigen gebruiker of een groepstoken. Zo hangt ze niet af van het account van één persoon.
Repository aan een project koppelen
Elke repository hoort bij precies één FeatValue-project. Alleen gekoppelde repositories komen in FeatValue terecht.
-
Repositories koppelen openen
-
Repository zoeken
Onder Repositories in GitLab staan uw repositories. Met Repository zoeken maakt u de lijst korter.
-
Project kiezen en koppelen
Kies naast de repository het FeatValue-project en klik op Koppelen. FeatValue maakt een webhook in GitLab aan en haalt de laatste dagen in.
Alle koppelingen staan onder Gekoppelde repositories. De kolom Bijwerken toont Direct via webhook of Elke 10 minuten. Met Wijzigen kiest u een ander project, met Ontkoppelen heft u de koppeling op; FeatValue verwijdert dan ook de webhook.
De taak-ID goed gebruiken
Elke taak in FeatValue heeft een ID, bijvoorbeeld abc123-4. U vindt die bij de taak. Zet deze ID op een van deze plekken:
| Waar |
Voorbeeld |
| Branchnaam |
abc123-4-contactformulier |
| Commitbericht |
abc123-4 Telefoonnummer verplicht maken |
| Titel of beschrijving van de merge request |
Contactformulier: telefoonnummer verplicht maken (abc123-4) |
- Hoofdletters en kleine letters maken niet uit, en een
# ervoor is toegestaan.
- Staat de ID in de branchnaam, dan tellen alleen de commits die uitsluitend op deze branch staan. Commits uit de standaardbranch die bij het aftakken zijn meegekomen, verschijnen niet bij de taak.
- Commits op andere branches verschijnen alleen als de ID in hun commitbericht staat.
- De ID geldt alleen binnen het gekoppelde project. Repositories die aan een ander project of helemaal niet gekoppeld zijn, wijst FeatValue nooit toe.
- Pipelines en deployments horen bij de taak als ze voor een van haar branches, commits of merge requests draaien.
Wat bij de taak verschijnt
De taak toont het onderdeel Ontwikkeling met één compacte regel, bijvoorbeeld: MR !12 gemerged · Pipeline geslaagd · Uitgerold op Staging. Met Details tonen klapt u het open:
- Pipelines met stages en jobs en hun status
- Omgevingen met een link om ze te openen, bijvoorbeeld Staging en Production
- Merge requests, Branches en Commits
Wat in het project verschijnt
In het project toont het onderdeel Ontwikkeling de omgevingen met hun laatste deployment en de laatste pipeline op de standaardbranch. Met Alle pipelines tonen ziet u de Laatste pipelines. Hier vindt u ook de Instellingen van het project.
Wat zien klanten?
Kies in het project in de Instellingen van het onderdeel Ontwikkeling onder Wat zien klanten?:
| Instelling |
Uw klant ziet |
| Niets |
geen informatie uit GitLab |
| Eenvoudige status |
één zin zonder vaktermen: In uitvoering, Uitgerold op Staging met de link hier testen, of Live met de link nu bekijken |
| Details |
de onderdelen die u aanvinkt onder Details voor klanten: commits, branches, merge requests, pipelines, omgevingen en geschiedenisreacties |
Mensen uit uw bedrijf die het project mogen bewerken, kunnen deze instelling wijzigen. Hoe uw klant daarna test en accepteert, leest u onder Review en acceptatie.
FeatValue zet belangrijke stappen als opmerking in het verloop van de taak. Onder Verloopcommentaren bij de taak kiest u per project welke gebeurtenissen een opmerking aanmaken:
- Merge request samengevoegd
- Pipeline geslaagd
- Pipeline mislukt (met mislukte jobs)
- Uitgerold naar omgeving
Uitgevinkte gebeurtenissen werken de status bij de taak nog steeds bij, maar maken geen opmerking meer aan. Of uw klant de opmerkingen ziet, hangt af van de instelling onder Wat zien klanten?.
Jobs starten vanuit FeatValue
Starter
Handmatige jobs uit uw pipeline, bijvoorbeeld deploy-production, start u direct in FeatValue. Dat is beschikbaar vanaf het Starter-abonnement (zie Plannen).
-
Jobs toestaan
Open in het project de Instellingen van het onderdeel Ontwikkeling. Onder Jobs starten vanuit FeatValue vindt u de handmatige jobs die GitLab tot nu toe heeft gemeld. Vink de jobs aan die in FeatValue moeten verschijnen en klik op Opslaan.
-
Ook voor klanten
Moet uw klant de gekozen jobs ook kunnen starten, vink dan Ook klanten mogen de gekozen jobs starten aan.
-
Job starten
Wacht een toegestane job op zijn handmatige start, dan verschijnt hij met de knop Starten. Na de klik toont FeatValue Gestart, en het verdere verloop volgt u in de pipeline.
Staat er Nog geen handmatige jobs gemeld., dan heeft er nog geen pipeline met een handmatige job gedraaid. Zodra GitLab er een meldt, kunt u die toestaan.
Beveiliging
- Alleen gekoppelde repositories: FeatValue leest alleen repositories die u aan een project hebt gekoppeld, en wijst taak-ID’s alleen binnen dat project toe.
- Geen code: FeatValue slaat geen bestanden uit uw repository op, alleen informatie over branches, commits, merge requests, pipelines en omgevingen.
- Gecontroleerde webhook: Elke webhook krijgt een eigen geheim token. FeatValue accepteert alleen aanroepen die dit token meesturen.
- Uw rechten in GitLab: FeatValue werkt met de rechten van de aanmelding of het token. Het kan alleen jobs starten die u hebt toegestaan.
- Altijd te ontkoppelen: Ontkoppelen heft een koppeling op, en FeatValue verwijdert de webhook.
Problemen oplossen
Mijn repository staat niet in de lijst
FeatValue toont alleen repositories waarin u minstens de rol Maintainer hebt. Controleer uw rol in GitLab of zoek de naam met Repository zoeken.
De webhook kon niet worden aangemaakt
De koppeling toont dan Elke 10 minuten in plaats van Direct via webhook. FeatValue kijkt in dat geval elke 10 minuten in GitLab, er gaat dus niets verloren, het komt alleen later binnen. Veelvoorkomende oorzaken: de rol Maintainer ontbreekt, of uw GitLab-instantie mag geen verzoeken naar internet sturen. Controleer dit en klik daarna op Wijzigen en opnieuw op Koppelen.
Er verschijnt niets bij de taak
- Is de repository gekoppeld aan het project waar de taak bij hoort?
- Staat de volledige taak-ID in de branchnaam, het commitbericht of de merge request?
- Zonder webhook duurt het tot 10 minuten voordat nieuwe gegevens binnenkomen.
GitLab heeft het token niet geaccepteerd
Controleer het adres van de instantie, het token en de scope api. Het token mag niet verlopen zijn.
Een job kan niet worden gestart
Jobs starten is beschikbaar vanaf het Starter-abonnement. De job moet bovendien in de projectinstellingen zijn toegestaan en op dit moment op zijn handmatige start wachten. Verschijnt Kon niet worden gestart, controleer dan in GitLab of de aanmelding de job nog mag starten.