Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.
Connessione GitHub
GitHub l'integrazione consente all' AWS DevOps agente di accedere agli archivi di codice e ricevere eventi di implementazione durante le indagini sugli incidenti. Questa integrazione segue un processo in due fasi: registrazione a livello di account GitHub, seguita dal collegamento di repository specifici a singoli Agent Spaces.
AWS DevOps L'agente supporta sia le GitHub.com istanze (SaaS) che quelle di GitHub Enterprise Server (ospitate autonomamente).
Prerequisiti
Prima di connetterti GitHub, assicurati di avere:
Accesso alla console di amministrazione AWS DevOps dell'agente
Un account GitHub utente o un'organizzazione con autorizzazioni di amministratore
Autorizzazione a installare GitHub app nel tuo account o nella tua organizzazione
Per GitHub Enterprise Server, sono inoltre necessari:
Un'istanza di GitHub Enterprise Server (versione 3.x o successiva) accessibile tramite HTTPS
L'URL HTTPS dell'istanza di GitHub Enterprise Server (ad esempio,
https://github.example.com)(Facoltativo) Una connessione privata, se l'istanza di GitHub Enterprise Server non è accessibile pubblicamente
Registrazione GitHub (a livello di account)
GitHub è registrato a livello di AWS account e condiviso tra tutti gli Agent Space di quell'account. Ogni registrazione corrisponde a un GitHub utente, un'organizzazione o un'istanza di GitHub Enterprise Server.
Fase 1: Accedere ai fornitori di pipeline
Accedi alla console di AWS gestione
Passa alla console AWS DevOps dell'agente
Vai alla scheda Funzionalità
Nella sezione Pipeline, scegli Aggiungi
Seleziona GitHubdall'elenco dei fornitori disponibili
Se GitHub non è ancora stato registrato, ti verrà prima richiesto di registrarlo.
Passaggio 2: Scegli il tipo di connessione
Nella schermata «Registra GitHub account /organizzazione», seleziona se ti stai connettendo come utente o organizzazione:
Utente: il tuo GitHub account personale con nome utente e profilo
Organizzazione: un GitHub account condiviso in cui più persone possono collaborare su più progetti contemporaneamente
Seleziona le autorizzazioni GitHub dell'app per la tua GitHub app. Il livello di autorizzazione determina le azioni che l' GitHub App può eseguire nel tuo repository:
Lettura e scrittura (impostazione predefinita): l' GitHub app richiede autorizzazioni di lettura e scrittura. Ciò abilita tutte le funzionalità. DevOps L'agente può pubblicare commenti in linea sulle pull request, proporre correzioni e attivare flussi di lavoro.
Sola lettura: l' GitHub app richiede solo autorizzazioni di lettura. DevOps L'agente può visualizzare il codice e le richieste pull ma non può pubblicare commenti, proporre correzioni o attivare flussi di lavoro.
Se ti connetti a un'istanza di GitHub Enterprise Server, seleziona la casella di controllo Usa GitHub Enterprise Server e inserisci l'URL HTTPS dell'istanza (ad esempio,). https://github.example.com
Se l'istanza di GitHub Enterprise Server non è accessibile pubblicamente, è possibile configurare facoltativamente una connessione privata per consentire ad AWS DevOps Agent di raggiungere l'istanza in modo sicuro. Per ulteriori informazioni, consulta Connessione a strumenti ospitati privatamente.
Nota
Non includete /api/v3 alcun percorso finale nell'URL: immettete solo l'URL di base.
Passaggio 3: configura l'app GitHub
Scegli Invia per iniziare il processo di configurazione dell'app. I passaggi successivi variano a seconda che ci si stia connettendo a Enterprise Server GitHub.com o a GitHub Enterprise Server.
Per GitHub.com
Verrai reindirizzato GitHub all'installazione dell' GitHub app AWS DevOps Agent.
Seleziona l'account o l'organizzazione in cui installare l'app.
L'app consente all' AWS DevOps agente di ricevere eventi dagli archivi connessi, inclusi gli eventi di distribuzione.
Per GitHub Enterprise Server
GitHub Enterprise Server utilizza un flusso GitHub App Manifest, che configura automaticamente una nuova GitHub app sull'istanza. Ciò comporta due reindirizzamenti all'istanza di GitHub Enterprise Server.
Il browser verrà reindirizzato alla pagina «Crea GitHub app» dell'istanza GitHub Enterprise Server.
Verrà visualizzato il nome dell'app precompilato. Sentiti libero di cambiare il nome se necessario. Scegli Crea GitHub app.
Verrai reindirizzato ad AWS DevOps Agent, che scambia il codice manifesto con le credenziali dell'app.
Passaggio 4: Seleziona i repository e completa l'installazione
Verrà visualizzata la pagina di installazione e autorizzazione dell' GitHub app.
Seleziona a quali repository consentire l'accesso all'app:
Tutti gli archivi: concedi l'accesso a tutti gli archivi attuali e futuri
Seleziona solo i repository: scegli repository specifici dal tuo account o dalla tua organizzazione
Scegli Installa e autorizza.
Verrai reindirizzato nuovamente alla console dell' AWS DevOps agente, dove GitHub apparirà come registrato a livello di account.
Connessione dei repository a un Agent Space
Dopo la registrazione GitHub a livello di account, puoi connettere repository specifici a singoli Agent Spaces:
Nella console dell' AWS DevOps agente, seleziona il tuo Agent Space
Vai alla scheda Funzionalità
Nella sezione Pipeline, scegli Aggiungi
Seleziona GitHubdall'elenco dei fornitori disponibili
Seleziona la GitHub registrazione che contiene i repository che desideri utilizzare
Seleziona il sottoinsieme di repository pertinenti a questo Agent Space
Scegli Aggiungi per completare la connessione
Puoi connettere diversi set di repository a diversi Agent Spaces in base alle tue esigenze organizzative. Un singolo Agent Space può utilizzare i repository di più registrazioni. Per aggiungere repository da un'altra registrazione, ripeti questi passaggi.
Configurazione della revisione del codice e del test automatizzato
Quando si selezionano i repository nella fase di GitHub connessione, questi vengono aggiunti automaticamente alla sezione Code Review e Automated Testing. Questa sezione configura quali repository attivano automaticamente le funzionalità di test Revisioni del codice di preparazione al rilascio e quelle automatizzate.
La configurazione Code Review e Automated Testing include:
Funzionalità: scegli funzionalità di revisione del codice e test automatizzati per ogni repository. La sezione fornisce due impostazioni per repository:
Attivazione automatica della revisione delle modifiche: se abilitato per un repository, DevOps l'agente viene eseguito automaticamente Revisioni del codice di preparazione al rilascio ogni volta che viene aperta o aggiornata una pull request. I risultati della revisione vengono visualizzati come commenti in linea sulla pull request. Questa opzione è abilitata per impostazione predefinita per tutti i repository collegati.
Test di verifica automatizzati: se abilitato per un repository, DevOps l'agente crea, esegue e verifica le modifiche al codice in un ambiente di verifica gestito durante le revisioni del codice. Ciò fornisce una convalida funzionale oltre all'analisi statica. Per ulteriori informazioni, consulta Test di verifica automatizzati. Questa opzione è abilitata per impostazione predefinita per tutti gli archivi collegati.
Elenco dei repository: mostra tutti i repository selezionati durante la fase di connessione. Utilizza il campo di ricerca per filtrare i repository per nome. Ogni repository dispone di caselle di controllo indipendenti per entrambe le funzionalità.
Ruolo di runtime (opzionale): scegli il ruolo IAM che l' DevOps agente assume per eseguire funzionalità automatizzate sui repository selezionati. Questo ruolo viene utilizzato per accedere ai servizi interni necessari durante le compilazioni, come registri di pacchetti privati e sistemi di archiviazione degli artefatti. Ti consigliamo di utilizzare un ruolo diverso da quello di agente principale.
Per configurare le revisioni automatiche:
Dopo aver collegato i repository, accedi alla sezione Code Review and Automated Testing nelle impostazioni di GitHub integrazione.
Per ogni repository, abilita o disabilita la funzionalità di revisione delle modifiche con attivazione automatica delle pull request a seconda che desideri o meno revisioni automatiche delle pull request.
Per ogni repository, abilita o disabilita la funzionalità di test di verifica automatizzati a seconda che desideri eseguire i test di verifica automatizzati in un ambiente di verifica gestito.
Facoltativamente, seleziona un ruolo IAM dal menu a discesa del ruolo Runtime che l' DevOps agente assumerà durante l'esecuzione di funzionalità automatizzate sui repository selezionati.
Scegli Salva per applicare la configurazione.
Una volta configurata, ogni nuova pull request in un repository con Auto trigger change review abilitata attiverà automaticamente una revisione del codice di preparazione al rilascio. Se è abilitato anche il test di verifica automatizzato, la revisione include la convalida funzionale in un ambiente di verifica. Per ulteriori informazioni sulle revisioni del codice, consultaRevisioni del codice di preparazione al rilascio.
Comprendere l' GitHub app
L' GitHub app AWS DevOps Agent:
Richiede l'accesso ai tuoi repository: puoi rivedere le autorizzazioni specifiche durante GitHub l'installazione dell'app
Riceve eventi di distribuzione e altri eventi del repository
Consente all' AWS DevOps agente di correlare le modifiche al codice con gli incidenti operativi
Può essere disinstallato in qualsiasi momento tramite le impostazioni GitHub
Per GitHub Enterprise Server, l' GitHub app viene creata automaticamente sull'istanza durante la registrazione. È possibile gestire l'accesso all'archivio dell'app o disinstallarla tramite Impostazioni > Applicazioni > GitHub App installate. Per eliminare completamente la definizione dell'app, vai a Impostazioni > Impostazioni sviluppatore > GitHub App.
GitHub Aggiornamenti delle autorizzazioni delle app
AWS DevOps L'agente può richiedere aggiornamenti delle autorizzazioni dopo l'installazione GitHub dell'App per supportare nuove funzionalità. Quando ciò accade:
Riceverai una notifica GitHub relativa alla richiesta di aggiornamento delle autorizzazioni.
Controlla i dettagli dell'aggiornamento per capire quali nuove autorizzazioni vengono richieste.
Scegli Accetta nuove autorizzazioni per concedere le autorizzazioni aggiornate.
Non sono richieste modifiche al servizio o all'applicazione. Dopo aver accettato le autorizzazioni aggiornate, il token di accesso all'installazione successiva richiesto dall' AWS DevOps agente GitHub includerà automaticamente le nuove autorizzazioni.
Nota
Finché non accetti un aggiornamento delle autorizzazioni, AWS DevOps Agent continua a funzionare con le autorizzazioni concesse in precedenza. Le nuove funzionalità che dipendono dalle autorizzazioni aggiornate non saranno disponibili fino all'approvazione della richiesta. L'app manterrà le autorizzazioni attuali se scegli di non accettare le nuove autorizzazioni.
Autorizzazioni richieste
La tabella seguente descrive ogni autorizzazione richiesta dall' AWS DevOps Agent GitHub App e il motivo per cui è necessaria.
Se hai selezionato Sola lettura durante la registrazione, l' GitHub App richiede l'accesso a livello di lettura solo per ogni autorizzazione nella tabella seguente. Con le autorizzazioni di sola lettura, l' GitHub app non può eseguire le azioni a livello di scrittura elencate nella colonna Scopo.
| Autorizzazione | Livello di accesso | Scopo |
|---|---|---|
| Controlli | Leggi e scrivi | La revisione del codice di idoneità dopo il rilascio risulta man mano che viene eseguito il check sulle pull request, permettendo così di visualizzare lo stato della revisione direttamente nell' GitHub interfaccia utente. |
| Flussi di lavoro | Leggi e scrivi | Leggi le definizioni dei flussi di lavoro e attiva i flussi di lavoro GitHub Actions per i test di rilascio nelle tue CI/CD pipeline. |
| Azioni | Leggi e scrivi | Il flusso di lavoro Monitor GitHub Actions viene eseguito e accedi ai registri di esecuzione durante le indagini sugli incidenti e i test di rilascio. |
| Indice | Leggi e scrivi | Leggi il codice sorgente del repository per l'analisi della revisione del codice e la mappatura delle dipendenze. L'accesso in scrittura consente all'agente di proporre correzioni per i problemi identificati. |
| Richieste pull | Leggi e scrivi | Leggi i dettagli della pull request per attivare revisioni automatiche del codice. L'accesso in scrittura consente di pubblicare commenti di revisione in linea con i risultati e le correzioni consigliate. |
Gestione delle connessioni GitHub
Aggiornamento dell'accesso all'archivio: per modificare i repository a cui l' GitHub app può accedere, accedi alle impostazioni dell' GitHub account o dell'organizzazione (o alle impostazioni dell'istanza GitHub Enterprise Server), accedi alle GitHub app installate e modifica la configurazione dell'app AWS DevOps Agent.
Visualizzazione degli archivi collegati: nella console dell' AWS DevOps agente, seleziona Agent Space e vai alla scheda Funzionalità per visualizzare gli archivi collegati nella sezione Pipeline.
Rimozione della GitHub connessione: per disconnetterti GitHub da un Agent Space, seleziona la connessione nella sezione Pipeline e scegli Rimuovi. Per disinstallare completamente l' GitHub app, disinstallala dalle impostazioni dell' GitHub account o dell'organizzazione. Per GitHub Enterprise Server, poiché l' GitHub app viene creata direttamente sull'istanza durante la registrazione, è possibile opzionalmente ripulire completamente l'app eseguendo entrambe le seguenti operazioni:
Disinstalla l'app: vai su Impostazioni > Applicazioni > GitHub App installate, scegli Configura sull'app, quindi disinstallala.
Elimina l'app: vai su Impostazioni > Impostazioni sviluppatore > GitHub App, seleziona l'app, vai alla scheda Avanzate e scegli Elimina GitHub app. Avviso: l'eliminazione dell' GitHub app è permanente e non può essere annullata. Se la elimini, dovrai registrare nuovamente GitHub Enterprise Server dall'inizio nella console di AWS DevOps Agent per creare una nuova app.
