Integrazione GitLab

Con l’integrazione GitLab vede merge request, pipeline, ambienti e commit direttamente sulle Sue attività in FeatValue. I Suoi clienti sanno con parole semplici se la loro modifica è in lavorazione, su staging da testare o già online.

A cosa serve l’integrazione GitLab

Software house e web agency ricevono continuamente la stessa domanda: “È già online?”. Con l’integrazione, FeatValue risponde direttamente sull’attività:

  • Branch, commit e merge request con l’ID dell’attività compaiono sull’attività corrispondente.
  • Pipeline e deployment mostrano se la modifica è stata testata e quale ambiente ha raggiunto.
  • FeatValue scrive i passaggi importanti come commenti nella cronologia dell’attività.
  • Per ogni progetto decide Lei cosa vedono i Suoi clienti.
  • Avvia i job manuali, come un deployment, direttamente da FeatValue.

Una panoramica si trova nella pagina sull’integrazione GitLab.

Requisiti

  • un account FeatValue della Sua azienda con almeno un cliente e un progetto (vedere Creare Progetti)
  • GitLab su gitlab.com o come istanza propria, raggiungibile tramite https
  • almeno il ruolo Maintainer nei progetti GitLab che vuole collegare. Così FeatValue può creare il webhook.

Collegare GitLab

  1. Aprire l’app

    Clicchi su App nella sidebar sinistra, scelga GitLab e clicchi su Installare (vedere Collegare le App). Compare la pagina Collega GitLab con la domanda Dove si trova il tuo GitLab?
  2. gitlab.com

    Scelga gitlab.com e clicchi su Continua. Acceda a GitLab e consenta l’accesso. Così FeatValue ottiene l’accesso ai Suoi progetti.
  3. Istanza GitLab propria

    Scelga Istanza GitLab propria. Inserisca l’indirizzo https in Indirizzo dell’istanza, ad esempio https://gitlab.example.com, e un token in Personal access token. Clicchi su Continua.

Quale token serve per un’istanza propria?

Crei il token in GitLab in Preferenze › Access tokens:

  • Scope: api. Gli scope di sola lettura come read_api non bastano, perché FeatValue crea webhook e avvia job manuali.
  • Ruolo: L’utente del token deve avere almeno il ruolo Maintainer nei progetti.
  • Data di scadenza: Quando il token scade, non arrivano più nuovi dati. Ne crei uno nuovo e colleghi di nuovo GitLab.
Idealmente usi un utente dedicato o un token di gruppo per l’integrazione. Così non dipende dall’account di una singola persona.

Collegare un repository a un progetto

Ogni repository appartiene esattamente a un progetto FeatValue. Solo i repository collegati arrivano a FeatValue.

  1. Aprire Collega repository

    Apra Impostazioni › Azienda › Integrazioni e app e scelga GitLab (vedere App collegate). La pagina si chiama Collega repository.
  2. Trovare il repository

    I Suoi repository sono elencati in Repository in GitLab. Con Cerca repository restringe l’elenco.
  3. Scegliere il progetto e collegare

    Accanto al repository scelga il Progetto FeatValue e clicchi su Collega. FeatValue crea un webhook in GitLab e recupera gli ultimi giorni.

Tutti i collegamenti sono elencati in Repository collegati. La colonna Aggiornamento mostra Subito tramite webhook oppure Ogni 10 minuti. Con Modifica sceglie un altro progetto, con Scollega rimuove il collegamento; FeatValue elimina allora anche il webhook.

Usare correttamente l’ID dell’attività

Ogni attività in FeatValue ha un ID, ad esempio abc123-4. Lo trova sull’attività. Inserisca questo ID in uno di questi punti:

Dove Esempio
Nome del branch abc123-4-modulo-contatti
Messaggio di commit abc123-4 Rendere obbligatorio il telefono
Titolo o descrizione della merge request Modulo contatti: telefono obbligatorio (abc123-4)
  • Maiuscole e minuscole non contano, ed è ammesso un # davanti.
  • Se l’ID è nel nome del branch, contano solo i commit che esistono unicamente su questo branch. I commit del branch predefinito che arrivano al momento della creazione del branch non compaiono sull’attività.
  • I commit su altri branch compaiono solo se l’ID è nel loro messaggio di commit.
  • L’ID vale solo all’interno del progetto collegato. FeatValue non assegna mai repository collegati a un altro progetto o non collegati.
  • Pipeline e deployment appartengono all’attività se vengono eseguiti per uno dei suoi branch, commit o merge request.

Cosa compare sull’attività

L’attività mostra la sezione Sviluppo con una riga compatta, ad esempio: MR !12 unita · Pipeline riuscita · Rilasciato su Staging. Con Mostra dettagli la espande:

  • Pipeline con fasi, job e il loro stato
  • Ambienti con un link per aprirli, ad esempio Staging e Production
  • Merge request, Branch e Commit

Cosa compare nel progetto

Nel progetto, la sezione Sviluppo mostra gli ambienti con il loro ultimo deployment e l’ultima pipeline sul branch predefinito. Con Mostra tutte le pipeline vede le Ultime pipeline. Qui trova anche le Impostazioni del progetto.

Cosa vedono i clienti?

Nelle Impostazioni della sezione Sviluppo nel progetto, scelga in Cosa vedono i clienti?:

Impostazione Il Suo cliente vede
Niente nessuna informazione da GitLab
Stato semplice una frase senza termini tecnici: In lavorazione, Rilasciato su Staging con il link provalo qui, oppure Online con il link guarda ora
Dettagli le sezioni che spunta in Dettagli per i clienti: commit, branch, merge request, pipeline, ambienti e commenti di cronologia

Possono modificare questa impostazione le persone della Sua azienda autorizzate a modificare il progetto. Come il Suo cliente poi testa e accetta è spiegato in Revisione e accettazione.

Configurare i commenti di cronologia

FeatValue scrive i passaggi importanti come commenti nella cronologia dell’attività. In Commenti di cronologia sull’attività sceglie per ogni progetto quali eventi creano un commento:

  • Merge request unita
  • Pipeline riuscita
  • Pipeline non riuscita (con job non riusciti)
  • Rilasciato nell’ambiente

Gli eventi deselezionati aggiornano comunque lo stato sull’attività, ma non creano più commenti. Se il Suo cliente vede i commenti dipende dall’impostazione in Cosa vedono i clienti?.

Avviare job da FeatValue Starter

Avvia i job manuali della Sua pipeline, ad esempio deploy-production, direttamente in FeatValue. La funzione è disponibile dal piano Starter (vedere Piani).

  1. Consentire i job

    Nel progetto apra le Impostazioni della sezione Sviluppo. In Avviare job da FeatValue trova i job manuali segnalati finora da GitLab. Spunti i job che devono comparire in FeatValue e clicchi su Salva.
  2. Anche per i clienti

    Se anche il Suo cliente deve poter avviare i job selezionati, spunti Anche i clienti possono avviare i job selezionati.
  3. Avviare un job

    Quando un job consentito attende l’avvio manuale, compare con il pulsante Avvia. Dopo il clic FeatValue mostra Avviato, e il resto lo segue sulla pipeline.
Se compare Nessun job manuale segnalato finora., non è ancora stata eseguita nessuna pipeline con un job manuale. Appena GitLab ne segnala uno, può consentirlo.

Sicurezza

  • Solo repository collegati: FeatValue legge solo i repository che ha collegato a un progetto e assegna gli ID delle attività solo all’interno di quel progetto.
  • Nessun codice: FeatValue non salva file del Suo repository, ma solo informazioni su branch, commit, merge request, pipeline e ambienti.
  • Webhook verificato: Ogni webhook riceve un proprio token segreto. FeatValue accetta solo le chiamate che inviano questo token.
  • I Suoi permessi in GitLab: FeatValue lavora con i permessi dell’accesso o del token. Può avviare solo i job che Lei ha consentito.
  • Scollegare in qualsiasi momento: Scollega rimuove un collegamento e FeatValue elimina il webhook.

Risoluzione dei problemi

Il mio repository non compare nell’elenco

FeatValue mostra solo i repository in cui ha almeno il ruolo Maintainer. Controlli il Suo ruolo in GitLab o cerchi il nome con Cerca repository.

Non è stato possibile creare il webhook

Il collegamento mostra allora Ogni 10 minuti invece di Subito tramite webhook. In questo caso FeatValue controlla GitLab ogni 10 minuti: non si perde nulla, arriva solo più tardi. Cause frequenti: Le manca il ruolo Maintainer, oppure la Sua istanza GitLab non può inviare richieste verso internet. Lo verifichi, poi clicchi su Modifica e di nuovo su Collega.

Sull’attività non compare nulla

  • Il repository è collegato al progetto a cui appartiene l’attività?
  • L’ID completo dell’attività è nel nome del branch, nel messaggio di commit o nella merge request?
  • Senza webhook, i nuovi dati arrivano entro un massimo di 10 minuti.

GitLab non ha accettato il token

Controlli l’indirizzo dell’istanza, il token e lo scope api. Il token non deve essere scaduto.

Un job non si può avviare

L’avvio dei job è disponibile dal piano Starter. Inoltre il job deve essere consentito nelle impostazioni del progetto e attendere in quel momento l’avvio manuale. Se compare Impossibile avviare, verifichi in GitLab se l’accesso può ancora avviare il job.

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 • Impressum • Terms and Conditions