Con l’integrazione GitHub vede pull request, run di GitHub Actions, 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 GitHub
Software house e web agency ricevono continuamente la stessa domanda: “È già online?”. Con l’integrazione, FeatValue risponde direttamente sull’attività:
- Branch, commit e pull request con l’ID dell’attività compaiono sull’attività corrispondente.
- I run di GitHub Actions e i 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.
- Riesegue i run falliti direttamente da FeatValue.
Una panoramica si trova nella pagina sull’integrazione GitHub.
Requisiti
- un account FeatValue della Sua azienda con almeno un cliente e un progetto (vedere Creare Progetti)
- un account o un’organizzazione su github.com
- il diritto di installare app su questo account o su questa organizzazione. Nelle organizzazioni sono gli owner. Gli altri membri possono richiedere l’installazione, che un owner poi approva in GitHub.
Collegare GitHub
-
Aprire l’app
Clicchi su
App nella sidebar sinistra, scelga
GitHub e clicchi su
Installare (vedere
Collegare le App).
-
Connettere con GitHub
Clicchi su
Connetti con GitHub. Una breve nota indica i permessi richiesti dall’app (vedere
Permessi della GitHub App). Clicchi su
Continua su GitHub.
-
Accedere a GitHub
Acceda a GitHub e autorizzi l’app FeatValue.
-
Installare l’app o scegliere le organizzazioni
Se l’app non è ancora installata da nessuna parte, GitHub apre subito l’installazione: scelga il Suo account o un’organizzazione, poi All repositories oppure, in Only select repositories, i repository che FeatValue può vedere, e clicchi su Install. Se l’app è già installata in più organizzazioni, sceglie in una pagina di selezione le organizzazioni da collegare. Poi torna a FeatValue.
Conceda l’accesso solo ai repository che vuole collegare a progetti FeatValue. Può modificare la selezione in qualsiasi momento in GitHub per l’app FeatValue: nell’account personale in Settings › Applications › Installed GitHub Apps, in un’organizzazione in Organization settings › Third-party Access › GitHub Apps.
Permessi della GitHub App
L’app FeatValue richiede a GitHub questi permessi:
- Metadata: read: nomi e dati di base dei repository a cui ha concesso l’accesso
- Contents: read: commit e confronti tra branch
- Pull requests: read: pull request con titolo, stato e branch
- Actions: read & write: leggere i run di GitHub Actions, scrivere solo per riavviare un run
- Deployments: read: deployment e ambienti
La GitHub App richiede l’accesso in lettura ai contenuti del repository (Contents: read) perché GitHub fornisce commit e confronti tra branch solo con questo permesso. FeatValue lo usa solo per leggere i dati dei commit (messaggio, autore, data e ora) e i confronti tra branch, mai il codice sorgente, e non salva alcun file.
Collegare un repository a un progetto
Ogni repository appartiene esattamente a un progetto FeatValue. Solo i repository collegati arrivano a FeatValue.
-
Aprire Collega repository
Apra
Impostazioni › Azienda › Integrazioni e app e scelga
GitHub (vedere
App collegate). La pagina si chiama
Collega repository.
-
Trovare il repository
I repository a cui ha concesso l’accesso all’app sono elencati in Repository in GitHub. Con Cerca repository restringe l’elenco.
-
Scegliere il progetto e collegare
Accanto al repository scelga il Progetto FeatValue e clicchi su Collega. FeatValue recupera gli ultimi giorni. Non deve creare alcun webhook: gli eventi arrivano tramite l’app FeatValue.
Tutti i collegamenti sono elencati in Repository collegati. La colonna Aggiornamento mostra Subito tramite webhook. Con Modifica sceglie un altro progetto, con Scollega rimuove il collegamento.
Più organizzazioni in un solo collegamento
Un collegamento FeatValue può usare l’app di tutte le organizzazioni e gli account GitHub in cui è installata e a cui Lei ha accesso al momento del collegamento, ad esempio la Sua organizzazione e quelle dei Suoi clienti. L’elenco nella pagina Collega repository è raggruppato per organizzazione.
-
Aggiungere un’organizzazione
Apra Impostazioni › GitHub (pagina Collega repository) e clicchi su Aggiungi organizzazione.
-
Scegliere l’organizzazione
Scelga un’organizzazione in cui l’app è già installata. Se manca, clicchi su Installa in un’altra organizzazione e installi lì l’app in GitHub.
-
Collegare i repository
I repository dell’organizzazione compaiono nell’elenco. Li colleghi come descritto sopra.
Più aziende in FeatValue possono usare la stessa installazione, ad esempio la Sua agenzia e il Suo cliente con il proprio account FeatValue.
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 pull 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.
- I run di GitHub Actions e i deployment appartengono all’attività se vengono eseguiti per uno dei suoi branch, commit o pull request.
Cosa compare sull’attività
L’attività mostra la sezione Sviluppo con una riga compatta, ad esempio: PR #12 unita · Workflow riuscito · Rilasciato su Staging. Con Mostra dettagli la espande:
- Workflow: i run di GitHub Actions, ad esempio CI #57, con i loro job e il loro stato
- Ambienti dei Suoi deployment con un link per aprirli, ad esempio Staging e Production
- Pull request, Branch e Commit
Cosa compare nel progetto
Nel progetto, la sezione Sviluppo mostra gli ambienti con il loro ultimo deployment e l’ultimo run sul branch predefinito. Con Mostra tutte le esecuzioni di workflow vede le Ultime esecuzioni di workflow. 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 GitHub |
| 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, pull request, workflow, 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.
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:
- Pull request unita
- Workflow riuscito
- Workflow fallito (con job falliti)
- 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?.
Rieseguire i run falliti
Starter
Quando un run di GitHub Actions fallisce o viene annullato, lo riesegue direttamente in FeatValue. Per un run fallito GitHub riesegue solo i job non riusciti, per un run annullato l’intero run. La funzione è disponibile dal piano Starter (vedere Piani).
-
Consentire i workflow
Nel progetto apra le Impostazioni della sezione Sviluppo. In Rilanciare workflow da FeatValue trova i workflow per cui GitHub ha segnalato finora un run fallito, ad esempio CI. Spunti i workflow che devono comparire in FeatValue e clicchi su Salva.
-
Anche per i clienti
Se anche il Suo cliente deve poter rieseguire i workflow selezionati, spunti Anche i clienti possono rilanciare i workflow selezionati.
-
Rieseguire
Un run fallito di un workflow consentito compare con il pulsante Rilancia. Dopo il clic FeatValue mostra Rilanciato, e il resto lo segue sul run.
Sicurezza
- Solo repository autorizzati e collegati: L’app FeatValue vede solo i repository a cui concede l’accesso durante l’installazione. FeatValue assegna gli ID delle attività solo nei repository che ha collegato a un progetto, e solo all’interno di quel progetto.
- Nessun codice sorgente: FeatValue legge solo i dati dei commit e i confronti tra branch, mai il codice sorgente, e non salva file del Suo repository. Per questo l’app richiede Contents: read (vedere Permessi della GitHub App).
- Webhook verificati: GitHub firma ogni consegna a FeatValue. FeatValue accetta solo le chiamate con una firma valida.
- Pochi permessi di scrittura: L’unica cosa che l’app può modificare è la riesecuzione dei run di GitHub Actions, e solo per i workflow che Lei ha consentito.
- Scollegare in qualsiasi momento: Scollega rimuove un collegamento. Se disinstalla l’app in GitHub, FeatValue scollega automaticamente i repository di quell’organizzazione.
Scollegare e disinstallare l’app
Se scollega GitHub in FeatValue, FeatValue elimina solo i collegamenti dei repository. Ciò che compare già sulle attività resta. L’app resta installata in GitHub finché non la disinstalla lì:
- Organizzazione: In GitHub apra Organization settings › Third-party Access › GitHub Apps, clicchi su Configure accanto all’app FeatValue e in fondo alla pagina su Uninstall.
- Account personale: Apra Settings › Applications › Installed GitHub Apps, clicchi su Configure accanto all’app FeatValue e poi su Uninstall.
Dopo la disinstallazione, FeatValue scollega automaticamente i repository di quell’organizzazione.
Risoluzione dei problemi
Il mio repository non compare nell’elenco
FeatValue mostra solo i repository a cui ha concesso l’accesso all’app. In GitHub apra Settings › Applications › Installed GitHub Apps, scelga l’app FeatValue e aggiunga il repository in Repository access. Per un’organizzazione lo trova nelle impostazioni dell’organizzazione.
L’installazione è in attesa di approvazione
Se non è owner dell’organizzazione, GitHub invia la richiesta di installazione agli owner. Appena un owner la approva, colleghi di nuovo GitHub in FeatValue.
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 pull request?
- Se una consegna di GitHub va persa, FeatValue la recupera entro 10 minuti.
Un run non si può rieseguire
La riesecuzione è disponibile dal piano Starter. Inoltre il workflow deve essere consentito nelle impostazioni del progetto, e il run deve essere fallito o annullato. Se compare Impossibile rilanciare, verifichi in GitHub se l’app è ancora installata e può vedere il repository.
Un’organizzazione manca nella selezione
FeatValue mostra solo le organizzazioni in cui l’app è installata e a cui il Suo account GitHub ha accesso. Installi l’app con Installa in un’altra organizzazione oppure lo chieda a un owner dell’organizzazione.