Crea un esempio di badge con CodeBuild - AWS CodeBuild

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à.

Crea un esempio di badge con CodeBuild

AWS CodeBuild ora supporta l'uso dei build badge, che forniscono un'immagine incorporabile e generata dinamicamente (badge) che mostra lo stato dell'ultima build di un progetto. Questa immagine è accessibile tramite un URL disponibile pubblicamente generato per il tuo progetto. CodeBuild Ciò consente a chiunque di visualizzare lo stato di un CodeBuild progetto. I badge di compilazione non contengono alcuna informazione di sicurezza, quindi non richiedono l'autenticazione.

Creazione di un progetto di compilazione con badge di compilazione abilitati (console)

  1. Apri la AWS CodeBuild console all'indirizzo https://console.aws.amazon.com/codesuite/codebuild/home.

  2. Se viene visualizzata una pagina di CodeBuild informazioni, scegli Crea progetto di compilazione. Altrimenti, nel riquadro di navigazione, espandi Crea, scegli Crea progetti, quindi scegli Crea progetto di compilazione.

  3. In Project name (Nome progetto) immettere un nome per questo progetto di compilazione. I nomi dei progetti di compilazione devono essere univoci per ogni AWS account. Puoi anche includere una descrizione opzionale del progetto di compilazione per aiutare gli altri utenti a capire a cosa serve questo progetto.

  4. In Source (Origine), per Source provider (Provider di origine), selezionare il tipo di provider di codice sorgente ed eseguire una delle operazioni seguenti:

    Nota

    CodeBuild non supporta i build badge con il provider di sorgenti Amazon S3. Poiché AWS CodePipeline utilizza Amazon S3 per il trasferimento di artefatti, i badge di costruzione non sono supportati per i progetti di compilazione che fanno parte di una pipeline creata in. CodePipeline

    • Se hai scelto CodeCommit, allora per Repository, scegli il nome del repository. Selezionare Enable build badge (Abilita badge di compilazione) per rendere visibile e integrabile lo stato della compilazione del progetto.

    • Se lo desideri GitHub, segui le istruzioni per connetterti (o riconnetterti) con. GitHub Nella pagina GitHub Autorizza l'applicazione, per l'accesso all'organizzazione, scegli Richiedi accesso accanto a ciascun repository AWS CodeBuild a cui desideri poter accedere. Dopo aver selezionato Authorize application (Autorizza applicazione), nella console AWS CodeBuild , per Repository (Archivio), selezionare il nome dell'archivio che contiene il codice sorgente. Selezionare Enable build badge (Abilita badge di compilazione) per rendere visibile e integrabile lo stato della compilazione del progetto.

    • Se si è selezionato Bitbucket, seguire le istruzioni per connettersi (o riconnettersi) a Bitbucket. Nella pagina Bitbucket Confirm access to your account (Conferma l'accesso all'account), per Organization access (Accesso organizzazione), selezionare Grant access (Concedi accesso). Dopo aver scelto Concedi l'accesso, torna nella AWS CodeBuild console, per Repository, scegli il nome del repository che contiene il codice sorgente. Selezionare Enable build badge (Abilita badge di compilazione) per rendere visibile e integrabile lo stato della compilazione del progetto.

      Importante

      Aggiornare il progetto sorgente potrebbe influire sulla precisione dei badge di compilazione del progetto.

  5. In Environment (Ambiente):

    Per Environment image (Immagine ambiente), procedere in uno dei seguenti modi:

    • Per utilizzare un'immagine Docker gestita da AWS CodeBuild, scegli Immagine gestita, quindi effettua le selezioni tra Sistema operativo, Runtime (s), Immagine e Versione dell'immagine. Se disponibile, eseguire una selezione da Environment type (Tipo ambiente).

    • Per utilizzare un'altra immagine Docker, selezionare Custom image (Immagine personalizzata). Per il tipo di ambiente, scegli ARM, Linux, Linux GPU o Windows. Se si sceglie Other registry (Altro registro), fin External registry URL (URL registro esterno), inserire il nome e il tag dell'immagine Docker in Docker Hub, utilizzando il formato docker repository/docker image name. Se scegli Amazon ECR, utilizza il repository Amazon ECR e l'immagine Amazon ECR per scegliere l'immagine Docker nel tuo account. AWS

    • Per utilizzare un'immagine Docker privata, scegli Immagine personalizzata. Per il tipo di ambiente, scegli ARM, Linux, Linux GPU o Windows. Per Image registry (Registro immagine), selezionare Other registry (Altro registro), quindi immettere l'ARN delle credenziali per l'immagine Docker privata. Le credenziali devono essere create da Secrets Manager. Per ulteriori informazioni, consulta Che cos'è AWS Secrets Manager? nella Guida per l'utente di AWS Secrets Manager .

  6. In Service role (Ruolo del servizio), procedere in uno dei seguenti modi:

    • Se non disponi di un ruolo CodeBuild di servizio, scegli Nuovo ruolo di servizio. In Nome ruolo, inserisci un nome per il nuovo ruolo.

    • Se hai un ruolo CodeBuild di servizio, scegli Ruolo di servizio esistente. In Role ARN, scegli il ruolo di servizio.

    Nota

    Quando utilizzi la console per creare o aggiornare un progetto di build, puoi creare contemporaneamente un ruolo di CodeBuild servizio. Per impostazione predefinita, il ruolo funziona solo con tale progetto di compilazione. Se si utilizza la console per associare questo ruolo del servizio con un altro progetto di compilazione, il ruolo viene aggiornato per funzionare con l'altro progetto. Un ruolo del servizio può funzionare con un massimo di 10 progetti di compilazione.

  7. In Buildspec, esegui una delle seguenti operazioni:

    • Scegliete Usa un file buildspec per usare il file buildspec.yml nella directory principale del codice sorgente.

    • Scegli Inserisci comandi di compilazione per utilizzare la console per inserire i comandi di compilazione.

    Per ulteriori informazioni, consulta Riferimento per buildspec.

  8. In Artifacts (Artefatti), per Type (Tipo), procedere in uno dei seguenti modi:

    • Se non si desidera creare artefatti di output di compilazione, scegliere No artifacts (Nessun artefatto).

    • Per archiviare l'output della build in un bucket S3, scegli Amazon S3, quindi procedi come segue:

      • Se desideri utilizzare il tuo nome di progetto per la cartella o il file ZIP di output di compilazione, lascia vuoto il campo Name (Nome). In caso contrario, digitare il nome. Per impostazione predefinita, il nome dell'artefatto è quello del progetto. Se si desidera utilizzare un nome diverso, immetterlo nella casella del nome degli artefatti. Se si desidera eseguire l'output di un file .ZIP, includere l'estensione .zip.

      • Per Bucket name (Nome bucket) selezionare il nome del bucket di output.

      • Se hai scelto Insert build commands (Inserisci comandi di compilazione) in una fase precedente di questa procedura, quindi per Output files (File di output), immetti le posizioni dei file di compilazione che desideri inserire nella cartella o nel file ZIP dell'output di compilazione. Per più posizioni, separarne ognuna con una virgola (per esempio, appspec.yml, target/my-app.jar). Per ulteriori informazioni, consultare la descrizione di files in Sintassi buildspec.

  9. Espandere Additional configuration (Configurazione aggiuntiva) e scegliere le opzioni come opportuno.

  10. Scegliere Create build project (Crea progetto di compilazione). Nella pagina Review (Verifica), selezionare Start build (Avvia compilazione) per eseguire la compilazione.

Creazione di un progetto di compilazione con badge di compilazione abilitati (CLI)

Per informazioni sulla creazione del progetto di compilazione, consultare Creazione di un progetto di compilazione (AWS CLI). Per includere badge di compilazione nel progetto AWS CodeBuild , è necessario specificare badgeEnabled con un valore di true.

Accedi ai tuoi badge di costruzione AWS CodeBuild

Puoi utilizzare la AWS CodeBuild console o accedere AWS CLI ai badge di costruzione.

  • Nella CodeBuild console, nell'elenco dei progetti di compilazione, nella colonna Nome, scegli il link che corrisponde al progetto di build. Nella pagina Build project: (Progetto di compilazione:) project-name (nome-progetto), in Configuration (Configurazione), selezionare Copy badge URL (Copia URL del badge). Per ulteriori informazioni, consulta Visualizzazione dei dettagli di un progetto di compilazione (console).

  • Nella AWS CLI, esegui il batch-get-projects comando. L'URL del badge di compilazione è incluso nella sezione dei dettagli dell'ambiente di progetto dell'output. Per ulteriori informazioni, consulta Visualizzazione dei dettagli di un progetto di compilazione (AWS CLI).

L'URL di richiesta del badge di compilazione viene generato con un ramo predefinito comune, ma puoi specificare qualsiasi ramo nel tuo repository di origine che hai utilizzato per eseguire una build. Per esempio:

https://codebuild.us-east-1.amazon.com/badges?uuid=...&branch=<branch>

Puoi anche specificare un tag dal tuo repository di origine sostituendo il branch parametro con il parametro nell'URL del badgetag. Per esempio:

https://codebuild.us-east-1.amazon.com/badges?uuid=...&tag=<tag>

Pubblica i tuoi badge di costruzione CodeBuild

Puoi visualizzare lo stato dell'ultima build in un file markdown usando l'URL del tuo build badge in un'immagine markdown. Ciò è utile per visualizzare lo stato della build più recente nel file readme.md nel repository dei sorgenti (ad esempio, o). GitHub CodeCommit Per esempio:

![](<build badge URL>)

CodeBuild stati dei badge

  • PASSING (PASSAGGIO) La più recente compilazione sul ramo determinato è passata.

  • FAILING (IN ERRORE) La più recente compilazione sul ramo determinato è scaduta, non è riuscita, ha problemi o è stata interrotta.

  • IN_PROGRESS (IN CORSO) La più recente compilazione nel ramo determinato è in corso.

  • UNKNOWN (SCONOSCIUTO) Il progetto non ha ancora eseguito una compilazione per il determinata ramo o per niente. Inoltre, la funzionalità dei badge di compilazione potrebbe essere stata disabilitata.