Configurazione di GitHub come repository di origine nelle catene di strumenti
Continuous Delivery Il servizio verrà interrotto nelle seguenti regioni il 12 febbraio 2027: au-syd, ca-tor, us-east. A partire da tale data, anche Code Risk Analyzer verrà ritirato dal mercato in tutte le regioni. Se in una regione non si riscontra un utilizzo attivo di queste funzionalità, queste potrebbero essere dismesse in anticipo e non accettare più nuove istanze. Scopri di più
Configura GitHub nella tua toolchain IBM Cloud per gestire il codice sorgente, collaborare tramite pull request e avviare l'esecuzione delle pipeline in seguito alle modifiche al codice.
GitHub Enterprise è un servizio host basato sul web, in loco per i repository Git.
Problemi GitHub è uno strumento di traccia che ti permette di lavorare sui tuoi piani in un solo posto. È integrato con il tuo repository di sviluppo in modo che puoi focalizzarti sulle attività importanti.
Puoi configurare GitHub come una integrazione dello strumento nella tua toolchain in modo da poter gestire il codice sorgente in un repository nuovo o esistente su GitHub.com o nell'istanza di GitHub Enterprise all'interno della tua azienda. Partecipa al social coding attraverso wiki, traccia dei problemi e richieste di pull.
Se stai configurando questa integrazione dello strumento mentre stai creando la toolchain, segui questi passi:
-
Se memorizzi il tuo codice sorgente in un repository GitHub, nella sezione Integrazioni configurabili, fai clic su GitHub. Se stai configurando l'integrazione di questo strumento su IBM Cloud Public, devi autorizzare IBM Cloud ad accedere a GitHub selezionando OAuth, " Token di accesso personale " o " App GitHub ".
-
Se si sceglie OAuth, fare clic su Authorize per accedere al sito web GitHub. Se non disponi di una sessione GitHub attiva, ti viene richiesto di accedere. Fai clic su Authorize Application per consentire a IBM Cloud di accedere al tuo account GitHub. Se hai una sessione di GitHub attiva ma non avevi immesso la tua password recentemente, ti potrebbe essere richiesto di immettere la tua password GitHub per la conferma.
-
Se scegli il token di accesso personale, devi immettere il token di accesso personale da utilizzare per autorizzare GitHub a clonare i repository ed eseguire altre azioni per tuo conto. Se non hai un token di accesso personale, puoi seguire la documentazione sul sito web GitHub per crearne uno. Assicurati che il token di accesso personale disponga dei diritti
repo,delete_repo,read:usereworkflow. -
Se scegli l'app " GitHub ", IBM Cloud utilizza l'installazione dell'app " GitHub " per effettuare l'autenticazione su GitHub per tuo conto, anziché un token OAuth. GitHub Le app offrono un controllo più granulare delle autorizzazioni e non dipendono dalle credenziali dei singoli utenti. Scegli uno dei seguenti metodi:
-
Gestito — Utilizza l'app " GitHub " fornita da IBM, preconfigurata per il tuo server GitHub. Fai clic su "Autorizza" per essere reindirizzato a GitHub,, dove potrai autorizzare l'accesso dell'app al tuo account.
-
Personalizzato — Utilizza la tua app " GitHub ". Inserisci la App ID e la chiave privata (formato PEM ) di un'app GitHub che hai registrato e installato nei tuoi repository. L'app deve essere installata su ogni repository che si desidera utilizzare con questa integrazione. Per ulteriori informazioni sulla creazione di un'app " GitHub ", consulta la documentazione " GitHub ".
-
-
-
Se stai utilizzando un repository sul tuo server GitHub Enterprise, nella sezione Integrazioni configurabili, fai clic su Server personalizzato.
a. Digita un titolo per il tuo GitHub server personalizzato, specifica la root URL per il server e inserisci il tuo token di accesso personale.
b. Se non hai un token di accesso personale, puoi seguire la documentazione sul sito web GitHub per crearne uno.
c. Se il vostro server GitHub è air-gapped o non è accessibile su Internet pubblico, potete collegare e integrare un Delivery Pipeline Private Worker da eseguire sulla vostra infrastruttura Kubernetes per accedere a risorse interne o in sede. Per ulteriori informazioni sui Delivery Pipeline Lavoratori privati, vedere Lavorare con Delivery Pipeline Lavoratori privati.
d. Se sul tuo server GitHub Enterprise è registrata un'app GitHub, puoi anche scegliere il metodo di autenticazione tramite l'app GitHub e inserire il tuo App ID e la chiave privata, oppure utilizzare l'app gestita se ne è stata preconfigurata una per il tuo server.
-
Rivedi le ubicazioni del repository di destinazione predefinite per i repository GitHub. Questi repository vengono clonati dai repository di esempio. Se necessario, modifica i nomi dei repository di destinazione.
Se disponi di una toolchain a cui stai aggiungendo questa integrazione dello strumento, completa la seguente procedura:
-
Dalla IBM Cloud console, clicca sull'
Menu > Automazione piattaforma > Catene di strumenti. Nella pagina Toolchains, fai clic sulla toolchain per aprirne la pagina di panoramica.
-
Fai clic su Add tool.
-
Nella sezione Integrazioni strumento, fai clic su GitHub.
-
Fai clic sul server GitHub server che vuoi utilizzare.
-
Se disponi di un repository GitHub o GitHub Enterprise e desideri utilizzarlo, per il tipo di repository, fai clic su Existing e immetti l'URL.
-
Se desideri utilizzare un nuovo repository GitHub o GitHub Enterprise, immetti un nome per il repository, digita l'URL per il repository che stai clonando o dividendo e seleziona il tipo di repository:
a. Per creare un repository vuoto, fai clic su New.
b. Per creare una copia di un repository GitHub o GitHub Enterprise, fai clic su Clone.
c. Per biforcare un repository GitHub o GitHub Enterprise in modo che sia possibile fornire le modifiche attraverso le richieste di importazione , fai clic su Fork.
-
Se sei un utente di GitHub.com con un account aggiornato o se hai selezionato un server GitHub Enterprise e vuoi creare un nuovo repository privato sul server, seleziona la casella di spunta Make this repository private.
-
Se desideri utilizzare Issues di GitLab per la traccia del problema, seleziona la casella di spunta Enable GitHub Issues.
-
Se desideri tracciare la distribuzione delle modifiche del codice creando tag e commenti nei commit e le etichette e i commenti sui problemi a cui fanno riferimento i commit, seleziona la casella di spunta Track deployment of code changes.
-
Fai clic su Crea integrazione.
-
Dalla pagina della panoramica della tua toolchain, sulla scheda Repository, fai clic sul repository GitHub o GitHub Enterprise con cui vuoi lavorare. A seconda del repository che hai selezionato, si aprirà il sito web di GitHub o il repository GitHub Enterprise della tua azienda, dove puoi visualizzare i contenuti del repository.
-
Se hai abilitato Problemi GitHub, fai clic su GitHub Issues per aprirlo. Puoi utilizzare questa istanza dei problemi GitHub per la toolchain completa, anche se la toolchain contiene più repository GitHub o GitHub Enterprise.
Se non hai i privilegi da amministratore per il repository a cui sei collegato, la tua integrazione è limitata perché non puoi utilizzare un webhook. I webhook sono richiesti per eseguire automaticamente una pipeline quando si esegue il push di un commit al repository. Senza un webhook, devi avviare le tue pipeline manualmente.
Configurazione di GitHub utilizzando l'API
L'integrazione GitHub degli strumenti supporta i seguenti parametri di configurazione che è possibile utilizzare con l 'API HTTP Toolchain e gli SDK durante la creazione, la lettura e l'aggiornamento delle integrazioni degli strumenti.
È necessario specificare la proprietà tool_type_id nel corpo della richiesta con il valore githubconsolidated.
| Parametro | Utilizzo | Immettere | Argomento Terraform | Descrizione |
|---|---|---|---|---|
| url root API | facoltativo, aggiornabile | Stringa | url root API | La URL della radice API per il GitHub server. |
| token API | facoltativo, aggiornabile | Password | token API | Il token di accesso personale (PAT). Questo parametro è obbligatorio solo se auth_type è impostato su pat, altrimenti viene ignorato. |
| auth_type | facoltativo, aggiornabile | Stringa | auth_type | Impostare il metodo di autenticazione da utilizzare per accedere al provider Git. I valori validi sono oauth, pat e github_app. Quando viene specificato " github_app ", l'autenticazione
utilizza un token di installazione dell'app GitHub anziché un token OAuth dell'utente o un PAT. |
| auto_init | opzionale, immutabile, Default: false |
Booleano | auto_init | Imposta questo valore su true per inizializzare questo repository con un file readme. Questo parametro viene utilizzato solo quando crei un repository. |
| connessione cieca | facoltativo, aggiornabile, Default: false |
Booleano | connessione cieca | L'impostazione di questo valore su true indica che il server non è indirizzabile su Internet pubblico. IBM Cloud non può convalidare i dettagli di connessione forniti. Alcune funzionalità che richiedono l'accesso API al server git verranno disabilitate. Delivery pipeline funzionerà solo utilizzando un operatore privato che ha accesso di rete al server git. |
| diramazione predefinita | facoltativo, aggiornabile | Stringa | diramazione predefinita | Il ramo predefinito del repository Git. |
| enable_traceability | facoltativo, aggiornabile, Default: false |
Booleano | enable_traceability | Imposta questo valore su true per monitorare l'implementazione delle modifiche al codice creando tag, etichette e commenti su commit, pull request e issue di riferimento. |
| id_git | facoltativo, immutabile | Stringa | id_git | Impostare questo valore su github per github.como sul GUID di un server GitHub Enterprise personalizzato. |
| github_app_auth_method | facoltativo, aggiornabile | Stringa | github_app_auth_method | Il metodo di autenticazione dell'app " GitHub " da utilizzare quando auth_type è github_app. Imposta l'opzione su " managed " per utilizzare l'app " GitHub " fornita
da IBM (impostazione predefinita), oppure su " custom " per fornire le tue credenziali dell'app " GitHub " tramite github_app_credential_app_id e github_app_credential_private_key. |
| github_app_credential_app_id | facoltativo, aggiornabile | Stringa | github_app_credential_app_id | Visita il sito GitHub App ID per un'app personalizzata GitHub. Obbligatorio quando " github_app_auth_method " è " custom". |
| github_app_credential_private_key | facoltativo, aggiornabile | Password | github_app_credential_private_key | La chiave privata RSA (in formato PEM ) per un'app personalizzata " GitHub ". Obbligatorio quando " github_app_auth_method " è " custom". La chiave è memorizzata in forma crittografata. |
| has_issues | facoltativo, aggiornabile, Default: true |
Booleano | problemi_toolchain_abilitati | Imposta questo valore su true per abilitare i problemi sul repository GitHub e aggiungi una scheda dello strumento Issues alla toolchain. Imposta il valore su false per rimuovere la scheda di integrazione dello
strumento dalla toolchain. Questa impostazione non influisce se i problemi sono abilitati sul repository GitHub stesso. |
| proprietario_integrazione | facoltativo, aggiornabile | Stringa | proprietario_integrazione | Selezionare l'utente con cui vengono eseguite le operazioni Git. |
| id_proprietario | facoltativo, immutabile | Stringa | id_proprietario | L'utente o l'organizzazione GitHub che possiede il repository. Questo parametro è obbligatorio quando crei un repository o cloni o biforca un repository. Questo valore viene calcolato quando ti colleghi a un repository esistente. |
| repo privato | opzionale, immutabile, Default: false |
Booleano | repo privato | Imposta questo valore su true per rendere privato il repository quando crei un repository o cloni o biforca un repository. Questo parametro non viene utilizzato quando ti colleghi a un repository esistente. |
| id_repo | facoltativo, immutabile | Stringa | id_repo | L'ID del repository GitHub. |
| repo_name | facoltativo, immutabile | Stringa | repo_name | Il nome del repository GitHub da creare. Questo parametro è obbligatorio quando crei un repository o cloni o biforca un repository. Questo valore viene calcolato quando ti colleghi a un repository esistente. |
| repo_url | facoltativo, immutabile | Stringa | repo_url | Il URL del repo GitHub per l'integrazione di questo strumento. Questo parametro è obbligatorio quando ti colleghi a un repository esistente. Questo valore viene calcolato quando crei un repository o cloni o biforca un repository. |
| url root | facoltativo, aggiornabile | Stringa | url root | La radice URL del server. Ad esempio: https://github.example.com |
| url_repo_origine | facoltativo, immutabile | Stringa | url_repo_origine | Il URL del repository che stai forkando o clonando. Questo parametro è obbligatorio quando esegui il fork o cloni un repository. Non viene utilizzato quando crei un repository o un link a un repository esistente. |
| titolo | facoltativo, aggiornabile | Stringa | titolo | Il titolo del server. Ad esempio, il mio server GitHub Enterprise |
| url_token | facoltativo, aggiornabile | Stringa | url_token | Il token URL utilizzato per l'autorizzazione con il GitHub server. |
| Immettere | richiesto, immutabile | Stringa | Immettere | L'operazione da eseguire per inizializzare la nuova integrazione dello strumento. Utilizza new per creare un repository Git, clone per clonare un repository esistente in un nuovo repository Git, fork per biforcare un repository Git esistente o link per collegarlo a un repository Git esistente. |
Utilizzo dell'autenticazione tramite l'app GitHub
GitHub L'autenticazione tramite app rappresenta un'alternativa ai metodi " OAuth " e "Personal Access Token" (PAT). GitHub Le app effettuano l'autenticazione come applicazione anziché come utente, il che garantisce autorizzazioni più granulari per i repository, l'assenza di dipendenza dalle credenziali dei singoli account utente e token che vengono automaticamente rinnovati e limitati a repository specifici.
Sono disponibili due modalità:
- Gestito (
github_app_auth_method: managed) - IBM Cloud utilizza un'applicazione GitHub fornita da IBM, già pre-registrata per il tuo server GitHub. L'autorizzazione all'app avviene tramite una procedura di consenso " OAuth " e il token utente-server risultante (
ghu_) viene memorizzato e utilizzato automaticamente. - Personalizzato (
github_app_auth_method: custom) - Puoi registrare e gestire la tua app “ GitHub ” su GitHub o GitHub Enterprise. L'utente deve fornire l' App ID e una chiave privata RSA codificata con PEM. IBM Cloud utilizza queste credenziali per generare automaticamente token di accesso
all'installazione a breve durata (
ghs_). L'app " GitHub " deve essere installata su ogni repository che si desidera utilizzare con questa integrazione.
Prima di iniziare con l'autenticazione personalizzata dell'app GitHub
Prima di configurare l'autenticazione personalizzata dell'app " GitHub ", segui questi passaggi:
-
Crea un'app " GitHub " nella tua organizzazione GitHub o nel tuo account personale. Concedi all'app almeno le seguenti autorizzazioni relative al repository:
- Contenuti: Lettura e scrittura
- Metadati: di sola lettura
- Pull request: lettura e scrittura (se si utilizza il monitoraggio delle pull request)
- Flussi di lavoro: lettura e scrittura (se le pipeline attivano azioni dell GitHub )
-
Genera una chiave privata per l'app e salva il file " PEM ". Ti servirà questa chiave quando configurerai l'integrazione.
-
Installa l'app " GitHub " sull'organizzazione o sui repository a cui accederà la tua toolchain. Per poter convalidare le credenziali, è necessario installare l'app.
Dopo aver configurato l'integrazione dello strumento con l' App ID e e la chiave privata, IBM Cloud verifica la validità delle credenziali richiamando l'API GitHub. Se l'app non è ancora installata in un repository specificato, verrà visualizzato un messaggio di errore che richiede di installarla prima.