Met de GitHub-integratie ziet u pull requests, GitHub Actions runs, 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 GitHub-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 pull requests met de taak-ID verschijnen bij de juiste taak.
- GitHub Actions runs 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.
- Mislukte runs start u direct vanuit FeatValue opnieuw.
Een overzicht vindt u op de pagina over de GitHub-integratie.
Vereisten
- een FeatValue-account van uw bedrijf met minstens één klant en project (zie Projecten aanmaken)
- een account of organisatie op github.com
- het recht om apps op dit account of deze organisatie te installeren. In organisaties zijn dat de owners. Andere leden kunnen de installatie aanvragen, waarna een owner die in GitHub goedkeurt.
GitHub koppelen
-
App openen
Klik in de linker zijbalk op
Apps, kies
GitHub en klik op
Installeren (zie
Apps koppelen).
-
Verbinden met GitHub
Klik op
Verbinden met GitHub. Een korte melding noemt de rechten die de app aanvraagt (zie
Rechten van de GitHub App). Klik op
Verder naar GitHub.
-
Aanmelden bij GitHub
Meld u aan bij GitHub en autoriseer de FeatValue-app.
-
App installeren of organisaties kiezen
Is de app nog nergens geïnstalleerd, dan opent GitHub direct de installatie: kies uw account of een organisatie, daarna All repositories of onder Only select repositories de repositories die FeatValue mag zien, en klik op Install. Is de app al in meerdere organisaties geïnstalleerd, dan kiest u op een keuzepagina de organisaties die u wilt koppelen. Daarna bent u terug in FeatValue.
Geef alleen toegang tot de repositories die u aan FeatValue-projecten wilt koppelen. U kunt de keuze altijd wijzigen in GitHub bij de FeatValue-app: in een persoonlijk account onder Settings › Applications › Installed GitHub Apps, in een organisatie onder Organization settings › Third-party Access › GitHub Apps.
Rechten van de GitHub App
De FeatValue-app vraagt bij GitHub deze rechten aan:
- Metadata: read: namen en basisgegevens van de vrijgegeven repositories
- Contents: read: commits en vergelijkingen van branches
- Pull requests: read: pull requests met titel, status en branch
- Actions: read & write: runs van GitHub Actions lezen, schrijven alleen voor run opnieuw starten
- Deployments: read: deployments en omgevingen
De GitHub App vraagt leestoegang tot de inhoud van repositories (Contents: read), omdat GitHub commits en vergelijkingen van branches alleen met dit recht geeft. FeatValue leest daarmee alleen commitgegevens (message, auteur, tijdstip) en vergelijkingen van branches, geen broncode, en slaat geen bestanden op.
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 GitHub staan de repositories waartoe u de app toegang hebt gegeven. Met Repository zoeken maakt u de lijst korter.
-
Project kiezen en koppelen
Kies naast de repository het FeatValue-project en klik op Koppelen. FeatValue haalt de laatste dagen in. U hoeft geen webhook aan te maken, gebeurtenissen komen binnen via de FeatValue-app.
Alle koppelingen staan onder Gekoppelde repositories. De kolom Bijwerken toont Direct via webhook. Met Wijzigen kiest u een ander project, met Ontkoppelen heft u de koppeling op.
Meerdere organisaties in één koppeling
Eén koppeling in FeatValue kan de app gebruiken uit alle GitHub-organisaties en accounts waarin hij is geïnstalleerd en waartoe u bij het koppelen toegang hebt, bijvoorbeeld uw eigen organisatie en de organisaties van uw klanten. De lijst op de pagina Repositories koppelen is gegroepeerd per organisatie.
-
Organisatie toevoegen
Open Instellingen › GitHub (pagina Repositories koppelen) en klik op Organisatie toevoegen.
-
Organisatie kiezen
Kies een organisatie waarin de app al is geïnstalleerd. Ontbreekt die, klik dan op Installeren in andere organisatie en installeer de app daar in GitHub.
-
Repositories koppelen
De repositories van de organisatie verschijnen in de lijst. Koppel ze zoals hierboven beschreven.
Meerdere bedrijven in FeatValue mogen dezelfde installatie gebruiken, bijvoorbeeld uw bureau en uw klant met een eigen FeatValue-account.
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 pull 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.
- GitHub Actions runs en deployments horen bij de taak als ze voor een van haar branches, commits of pull requests draaien.
Wat bij de taak verschijnt
De taak toont het onderdeel Ontwikkeling met één compacte regel, bijvoorbeeld: PR #12 gemerged · Workflow geslaagd · Uitgerold op Staging. Met Details tonen klapt u het open:
- Workflows: de GitHub Actions runs, bijvoorbeeld CI #57, met hun jobs en status
- Omgevingen uit uw deployments met een link om ze te openen, bijvoorbeeld Staging en Production
- Pull 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 run op de standaardbranch. Met Alle workflow-runs tonen ziet u de Laatste workflow-runs. 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 GitHub |
| 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, pull requests, workflows, 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:
- Pull request gemerged
- Workflow geslaagd
- Workflow 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?.
Mislukte runs opnieuw starten
Starter
Mislukt een GitHub Actions run of wordt hij geannuleerd, dan start u hem direct in FeatValue opnieuw. Bij een mislukte run voert GitHub alleen de mislukte jobs opnieuw uit, bij een geannuleerde run de hele run. Dat is beschikbaar vanaf het Starter-abonnement (zie Plannen).
-
Workflows toestaan
Open in het project de Instellingen van het onderdeel Ontwikkeling. Onder Workflows opnieuw starten vanuit FeatValue vindt u de workflows waarvoor GitHub tot nu toe een mislukte run heeft gemeld, bijvoorbeeld CI. Vink de workflows aan die in FeatValue moeten verschijnen en klik op Opslaan.
-
Ook voor klanten
Moet uw klant de gekozen workflows ook opnieuw kunnen starten, vink dan Ook klanten mogen de gekozen workflows opnieuw starten aan.
-
Opnieuw starten
Een mislukte run van een toegestane workflow verschijnt met de knop Opnieuw starten. Na de klik toont FeatValue Opnieuw gestart, en het verdere verloop volgt u in de run.
Beveiliging
- Alleen vrijgegeven en gekoppelde repositories: De FeatValue-app ziet alleen de repositories waartoe u bij de installatie toegang geeft. FeatValue wijst taak-ID’s alleen toe in repositories die u aan een project hebt gekoppeld, en alleen binnen dat project.
- Geen broncode: FeatValue leest alleen commitgegevens en vergelijkingen van branches, geen broncode, en slaat geen bestanden uit uw repository op. Daarvoor vraagt de app Contents: read aan (zie Rechten van de GitHub App).
- Gecontroleerde webhooks: GitHub ondertekent elke levering aan FeatValue. FeatValue accepteert alleen aanroepen met een geldige handtekening.
- Weinig schrijfrechten: Het enige wat de app mag wijzigen, is het opnieuw starten van GitHub Actions runs, en alleen voor de workflows die u hebt toegestaan.
- Altijd te ontkoppelen: Ontkoppelen heft een koppeling op. Verwijdert u de app in GitHub, dan ontkoppelt FeatValue automatisch de repositories van die organisatie.
Koppeling verbreken en app verwijderen
Verbreekt u de koppeling met GitHub in FeatValue, dan verwijdert FeatValue alleen de koppelingen van de repositories. Wat al bij taken staat, blijft bewaard. De app blijft in GitHub geïnstalleerd tot u hem daar verwijdert:
- Organisatie: Open in GitHub Organization settings › Third-party Access › GitHub Apps, klik bij de FeatValue-app op Configure en helemaal onderaan op Uninstall.
- Persoonlijk account: Open Settings › Applications › Installed GitHub Apps, klik bij de FeatValue-app op Configure en daarna op Uninstall.
Na het verwijderen ontkoppelt FeatValue automatisch de repositories van die organisatie.
Problemen oplossen
Mijn repository staat niet in de lijst
FeatValue toont alleen repositories waartoe u de app toegang hebt gegeven. Open in GitHub Settings › Applications › Installed GitHub Apps, kies de FeatValue-app en voeg de repository toe onder Repository access. Bij een organisatie vindt u dit in de instellingen van de organisatie.
De installatie wacht op goedkeuring
Bent u geen owner van de organisatie, dan stuurt GitHub de installatieaanvraag naar de owners. Zodra een owner die goedkeurt, koppelt u GitHub opnieuw in FeatValue.
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 pull request?
- Gaat een levering van GitHub verloren, dan haalt FeatValue die binnen 10 minuten in.
Een run kan niet opnieuw worden gestart
Opnieuw starten is beschikbaar vanaf het Starter-abonnement. De workflow moet bovendien in de projectinstellingen zijn toegestaan, en de run moet mislukt of geannuleerd zijn. Verschijnt Kon niet opnieuw worden gestart, controleer dan in GitHub of de app nog geïnstalleerd is en de repository mag zien.
Een organisatie ontbreekt in de keuze
FeatValue toont alleen organisaties waarin de app is geïnstalleerd en waartoe uw GitHub-account toegang heeft. Installeer de app via Installeren in andere organisatie of vraag een owner van de organisatie dat te doen.