Guida introduttiva agli archivi di CodeCatalyst origine e al modello di applicazione a pagina singola - Amazon CodeCatalyst
Creazione di un progetto con un blueprintVisualizzazione degli archivi di un progettoCreazione di un ambiente di sviluppoCreazione di una richiesta di pullUnire una pull requestVisualizzazione del codice distribuitoPulizia delle risorse

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

Guida introduttiva agli archivi di CodeCatalyst origine e al modello di applicazione a pagina singola

Segui i passaggi di questo tutorial per imparare a lavorare con i repository di sorgenti in Amazon CodeCatalyst.

Il modo più rapido per iniziare a lavorare con i repository di sorgenti in Amazon CodeCatalyst è creare un progetto utilizzando un modello. Quando crei un progetto utilizzando un modello, le risorse vengono create automaticamente, incluso un archivio di sorgenti che include codice di esempio. Puoi usare questo repository e questo esempio di codice per imparare a:

  • Visualizza gli archivi dei sorgenti di un progetto e sfogliane il contenuto

  • Crea un ambiente di sviluppo con una nuova filiale in cui puoi lavorare sul codice

  • Modifica un file, esegui il commit e invia le modifiche

  • Crea una pull request e rivedi le modifiche al codice con altri membri del progetto

  • Visualizza il flusso di lavoro del tuo progetto, crea e testa automaticamente le modifiche nel ramo sorgente della pull request

  • Unisci le modifiche dal ramo di origine al ramo di destinazione e chiudi la pull request

  • Guarda le modifiche unite create e distribuite automaticamente

Per ottenere il massimo da questo tutorial, invita altre persone al tuo progetto in modo da poter lavorare insieme su una pull request. Puoi anche esplorare le funzionalità aggiuntive di CodeCatalyst, come la creazione di problemi e la loro associazione a una pull request, o la configurazione di notifiche e la ricezione di avvisi quando viene eseguito il flusso di lavoro associato. Per un'esplorazione completa di, vedi. CodeCatalyst Tutorial introduttivi

Creazione di un progetto con un blueprint

La creazione di un progetto è il primo passo per poter lavorare insieme. Puoi utilizzare un blueprint per creare il tuo progetto, che creerà anche un repository di sorgenti con codice di esempio e un flusso di lavoro che genererà e distribuirà automaticamente il codice quando lo modifichi. In questo tutorial, ti illustreremo un progetto creato con il blueprint dell'applicazione a pagina singola, ma puoi seguire le procedure per qualsiasi progetto con un repository di sorgenti. Assicurati di scegliere un IAM ruolo o di aggiungere un IAM ruolo se non ne hai uno durante la creazione del progetto. Ti consigliamo di utilizzare il CodeCatalystWorkflowDevelopmentRole-spaceNameruolo di servizio per questo progetto.

Se hai già un progetto, puoi passare aVisualizzazione degli archivi di un progetto.

Nota

Solo gli utenti con il ruolo di amministratore dello spazio o utente esperto possono creare progetti in CodeCatalyst. Se non ricopri questo ruolo e hai bisogno di un progetto su cui lavorare per questo tutorial, chiedi a qualcuno con uno di questi ruoli di creare un progetto per te e aggiungerti al progetto creato. Per ulteriori informazioni, consulta Concessione dell'accesso con ruoli utente.

Per creare un progetto con un blueprint

  1. Nella CodeCatalyst console, accedi allo spazio in cui desideri creare un progetto.

  2. Nella dashboard dello spazio, scegli Crea progetto.

  3. Scegli Inizia con un progetto.

    Suggerimento

    Puoi scegliere di aggiungere un blueprint fornendo ad Amazon Q i requisiti del tuo progetto in modo che Amazon Q ti suggerisca un blueprint. Per ulteriori informazioni, consulta Utilizzo di Amazon Q per scegliere un blueprint durante la creazione di un progetto o l'aggiunta di funzionalità e Best practice per l'utilizzo di Amazon Q per creare progetti o aggiungere funzionalità con blueprint. Questa funzionalità è disponibile solo nella regione Stati Uniti occidentali (Oregon).

    Questa funzionalità richiede che le funzionalità di intelligenza artificiale generativa siano abilitate per lo spazio. Per ulteriori informazioni, consulta Gestione delle funzionalità di intelligenza artificiale generativa.

  4. Dalla scheda CodeCatalyst Blueprint o Space blueprint, scegli un blueprint, quindi scegli Avanti.

  5. In Assegna un nome al progetto, inserisci il nome che desideri assegnare al progetto e i nomi delle risorse associate. Il nome deve essere univoco all'interno del tuo spazio.

  6. (Facoltativo) Per impostazione predefinita, il codice sorgente creato dal blueprint viene archiviato in un CodeCatalyst repository. In alternativa, è possibile scegliere di archiviare il codice sorgente del blueprint in un repository di terze parti. Per ulteriori informazioni, consulta Aggiungi funzionalità ai progetti con estensioni in CodeCatalyst.

    Importante

    CodeCatalyst non supporta il rilevamento delle modifiche nel ramo predefinito per gli archivi collegati. Per modificare il ramo predefinito per un repository collegato, è necessario prima scollegarlo CodeCatalyst, modificare il ramo predefinito e quindi collegarlo nuovamente. Per ulteriori informazioni, consulta Collegamento di GitHub repository, repository Bitbucket, repository di progetti e GitLab progetti Jira in CodeCatalyst.

    È consigliabile assicurarsi sempre di disporre della versione più recente dell'estensione prima di collegare un repository.

    Effettua una delle seguenti operazioni a seconda del provider di repository di terze parti che desideri utilizzare:

    • GitHub repository: Connect a un GitHub account.

      Scegli il menu a discesa Avanzato, scegli GitHub come provider del repository, quindi scegli l' GitHub account in cui desideri archiviare il codice sorgente creato dal blueprint.

      Nota

      Se stai collegando un GitHub account, devi creare una connessione personale per stabilire una mappatura delle identità tra la tua identità e la tua CodeCatalyst identità. GitHub Per ulteriori informazioni, consulta Connessioni personali e Accesso alle GitHub risorse con connessioni personali.

    • Archivi Bitbucket: Connect uno spazio di lavoro Bitbucket.

      Scegli il menu a discesa Avanzato, scegli Bitbucket come provider di repository, quindi scegli l'area di lavoro Bitbucket in cui desideri archiviare il codice sorgente creato dal blueprint.

    • GitLab repository: Connect a un GitLab utente.

      Scegli il menu a discesa Avanzato, scegli GitLab come provider del repository, quindi scegli l' GitLab utente in cui desideri archiviare il codice sorgente creato dal blueprint.

  7. In Risorse del progetto, configura i parametri del blueprint. A seconda del blueprint, potresti avere la possibilità di assegnare un nome al repository di origine.

  8. (Facoltativo) Per visualizzare i file di definizione con aggiornamenti basati sulle selezioni dei parametri di progetto effettuate, scegliete Visualizza codice o Visualizza flusso di lavoro da Genera anteprima del progetto.

  9. (Facoltativo) Scegli Visualizza dettagli dalla scheda del blueprint per visualizzare dettagli specifici sul blueprint, come una panoramica dell'architettura del blueprint, le connessioni e le autorizzazioni richieste e il tipo di risorse create dal blueprint.

  10. Seleziona Crea progetto.

La pagina di panoramica del progetto viene visualizzata non appena si crea un progetto o si accetta un invito a partecipare a un progetto e si completa la procedura di accesso. La pagina di panoramica del progetto per un nuovo progetto non contiene problemi aperti o richieste pull. Facoltativamente, puoi scegliere di creare un problema e assegnarlo a te stesso. Puoi anche scegliere di invitare qualcun altro al tuo progetto. Per ulteriori informazioni, consulta Creazione di un problema in CodeCatalyst e Invitare un utente a un progetto.

Visualizzazione degli archivi di un progetto

Come membro di un progetto, puoi visualizzare i repository dei sorgenti del progetto. Puoi anche scegliere di creare repository aggiuntivi. Se qualcuno con il ruolo di amministratore di Space ha installato e configurato i GitHub repository, i repository Bitbucket o l'estensione dei GitLab repository, puoi anche aggiungere collegamenti a repository di terze parti negli GitHub account, nelle aree di lavoro Bitbucket o negli utenti configurati per l'estensione. GitLab Per ulteriori informazioni, consulta Creazione di un repository di sorgenti e Guida rapida: installazione di estensioni, connessione di provider e collegamento di risorse in CodeCatalyst.

Nota

Per i progetti creati con il blueprint dell'applicazione a pagina singola, il nome predefinito per l'archivio di origine che contiene il codice di esempio è spa-app.

Per accedere agli archivi di origine di un progetto

  1. Accedete al progetto ed effettuate una delle seguenti operazioni:

    • Nella pagina di riepilogo del progetto, scegli il repository desiderato dall'elenco, quindi scegli Visualizza archivio.

    • Nel riquadro di navigazione, scegli Codice, quindi scegli Archivi di origine. Nei repository di origine, scegli il nome del repository dall'elenco. È possibile filtrare l'elenco dei repository digitando parte del nome del repository nella barra dei filtri.

  2. Nella home page del repository, visualizza il contenuto del repository e le informazioni sulle risorse associate, come il numero di richieste pull e i flussi di lavoro. Per impostazione predefinita, vengono visualizzati i contenuti del ramo predefinito. È possibile modificare la visualizzazione scegliendo un ramo diverso dall'elenco a discesa.

La pagina di panoramica del repository include informazioni sui flussi di lavoro e le richieste pull configurate per i rami di questo repository e i relativi file. Se hai appena creato il progetto, i flussi di lavoro iniziali per creare, testare e distribuire il codice continueranno a essere in esecuzione, poiché il completamento richiederà alcuni minuti. È possibile visualizzare i flussi di lavoro correlati e il relativo stato scegliendo il numero sotto Flussi di lavoro correlati, ma in questo modo verrà aperta la pagina Flussi di lavoro in CI/CD. Per questo tutorial, rimani sulla pagina di panoramica ed esplora il codice nel repository. Il contenuto del README.md file viene visualizzato in questa pagina sotto i file del repository. In File, viene mostrato il contenuto del ramo predefinito. Puoi modificare la visualizzazione del file per mostrare il contenuto di un altro ramo, se ne hai uno. La .codecatalyst cartella contiene il codice utilizzato per altre parti del progetto, come YAML i file del flusso di lavoro.

Per visualizzare il contenuto delle cartelle, scegliete la freccia accanto al nome della cartella per espanderla. Ad esempio, scegliete la freccia accanto src a per visualizzare i file per l'applicazione Web a pagina singola contenuta in quella cartella. Per visualizzare il contenuto di un file, sceglierlo nell'elenco. Si aprirà Visualizza file, in cui è possibile sfogliare il contenuto di più file. Puoi modificare anche singoli file nella console, ma per modificare più file, ti consigliamo di creare un ambiente di sviluppo.

Creazione di un ambiente di sviluppo

Puoi aggiungere e modificare file in un repository di origine nella CodeCatalyst console Amazon. Tuttavia, per lavorare in modo efficace con più file e rami, ti consigliamo di utilizzare un ambiente di sviluppo o di clonare il repository sul tuo computer locale. In questo tutorial, creeremo un ambiente di AWS Cloud9 sviluppo con un ramo denominato. develop Puoi scegliere un nome di ramo diverso, ma assegnando un nome al ramodevelop, verrà eseguito automaticamente un flusso di lavoro per creare e testare il codice quando creerai una pull request più avanti in questo tutorial.

Suggerimento

Se decidi di clonare un repository localmente anziché o in aggiunta all'utilizzo di un ambiente di sviluppo, assicurati di avere Git sul tuo computer locale o che includa IDE Git. Per ulteriori informazioni, consulta Configurazione per l'utilizzo dei repository di origine.

Per creare un ambiente di sviluppo con un nuovo ramo

  1. Apri la CodeCatalyst console all'indirizzo https://codecatalyst.aws/.

  2. Vai al progetto in cui desideri creare un ambiente di sviluppo.

  3. Scegli il nome del repository dall'elenco dei repository di origine per il progetto. In alternativa, nel riquadro di navigazione, scegli Codice, scegli Archivi di origine e scegli il repository per il quale desideri creare un ambiente di sviluppo.

  4. Nella home page del repository, scegli Crea ambiente di sviluppo.

  5. Scegli un supporto IDE dal menu a discesa. Per ulteriori informazioni, consulta Ambienti di sviluppo integrati supportati per gli ambienti di sviluppo.

  6. Scegli il repository da clonare, scegli Lavora in un nuovo ramo, inserisci il nome di un ramo nel campo Nome del ramo e scegli un ramo dal quale creare il nuovo ramo dal menu a discesa Crea ramo da.

  7. Facoltativamente, aggiungi un alias per Dev Environment.

  8. Facoltativamente, scegli il pulsante di modifica della configurazione dell'ambiente di sviluppo per modificare la configurazione di calcolo, archiviazione o timeout dell'ambiente di sviluppo.

  9. Scegli Create (Crea) . Durante la creazione dell'ambiente di sviluppo, la colonna di stato dell'ambiente di sviluppo mostrerà Avvio e la colonna di stato verrà visualizzata in esecuzione una volta creato l'ambiente di sviluppo. Si aprirà una nuova scheda con il tuo Dev Environment nell'ambiente IDE di tua scelta. Puoi modificare il codice, eseguire il commit e inviare le modifiche.

Dopo aver creato l'ambiente di sviluppo, puoi modificare i file, eseguire il commit delle modifiche e inviarle al test ramo. Per questo tutorial, modifica il contenuto tra i <p> tag nel App.tsx file nella src cartella per modificare il testo visualizzato sulla pagina web. Conferma e invia la modifica, quindi torna alla CodeCatalyst scheda.

Per apportare e promuovere una modifica da un ambiente di AWS Cloud9 sviluppo

  1. In AWS Cloud9, espandi il menu di navigazione laterale per sfogliare i file. srcEspandi e apriApp.tsx.

  2. Modifica il testo all'interno dei <p> tag.

  3. Salva il file, quindi esegui il commit e invia le modifiche utilizzando il menu Git. In alternativa, nella finestra del terminale, esegui il commit e invia le modifiche con i git push comandi git commit and.

    git commit -am "Making an example change"
git push
    Suggerimento

    Potrebbe essere necessario modificare le directory del terminale nella directory del repository Git prima di poter eseguire correttamente i comandi Git.

Creazione di una richiesta di pull

Puoi utilizzare le pull request per esaminare in modo collaborativo le modifiche al codice per individuare modifiche o correzioni minori, aggiunte di funzionalità importanti o nuove versioni del software rilasciato. In questo tutorial, creerai una pull request per rivedere le modifiche apportate al test ramo rispetto al ramo principale. La creazione di una pull request in un progetto creato con un modello avvierà anche un'esecuzione degli eventuali flussi di lavoro associati.

Per creare una pull request

  1. Vai al tuo progetto.

  2. Esegui una di queste operazioni:

    • Nel riquadro di navigazione, scegli Codice, scegli Richieste pull, quindi scegli Crea richiesta pull.

    • Nella home page del repository, scegli Altro, quindi scegli Crea richiesta pull.

    • Nella pagina del progetto, scegli Crea richiesta pull.

  3. Nel repository Source, assicurati che il repository di origine specificato sia quello che contiene il codice commesso. Questa opzione appare solo se non hai creato la pull request dalla pagina principale del repository.

  4. Nel ramo di destinazione, scegli il ramo in cui unire il codice dopo averlo esaminato.

  5. Nel ramo di origine, scegli il ramo che contiene il codice commesso.

  6. In Pull request title, inserisci un titolo che aiuti gli altri utenti a capire cosa deve essere esaminato e perché.

  7. (Facoltativo) Nella descrizione della richiesta Pull, fornisci informazioni come un link ai problemi o una descrizione delle modifiche.

    Suggerimento

    Puoi scegliere Write description for me per generare CodeCatalyst automaticamente una descrizione delle modifiche contenute nella pull request. Puoi apportare modifiche alla descrizione generata automaticamente dopo averla aggiunta alla pull request.

    Questa funzionalità richiede che le funzionalità di intelligenza artificiale generativa siano abilitate per lo spazio e non è disponibile per le richieste pull negli archivi collegati. Per ulteriori informazioni, consulta Gestione delle funzionalità di intelligenza artificiale generativa.

  8. (Facoltativo) In Problemi, scegli Problemi di collegamento, quindi scegli un problema dall'elenco o inserisci il relativo ID. Per scollegare un problema, scegli l'icona di scollegamento.

  9. (Facoltativo) In Revisori obbligatori, scegli Aggiungi revisori richiesti. Scegli dall'elenco dei membri del progetto per aggiungerli. I revisori obbligatori devono approvare le modifiche prima che la pull request possa essere unita al ramo di destinazione.

    Nota

    Non è possibile aggiungere un revisore sia come revisore obbligatorio che come revisore opzionale. Non puoi aggiungerti come revisore.

  10. (Facoltativo) In Revisori opzionali, scegli Aggiungi revisori opzionali. Scegli dall'elenco dei membri del progetto per aggiungerli. I revisori opzionali non devono approvare le modifiche come requisito prima che la pull request possa essere unita al ramo di destinazione.

  11. Esamina le differenze tra le filiali. La differenza mostrata in una pull request è rappresentata dalle modifiche tra la revisione nel ramo di origine e la base di unione, che è l'head commit del ramo di destinazione al momento della creazione della pull request. Se non viene visualizzata alcuna modifica, i rami potrebbero essere identici oppure potresti aver scelto lo stesso ramo sia per l'origine che per la destinazione.

  12. Quando sei sicuro che la pull request contenga il codice e le modifiche che desideri rivedere, scegli Crea.

    Nota

    Dopo aver creato la pull request, puoi aggiungere commenti. I commenti possono essere aggiunti alla pull request o alle singole righe dei file, nonché alla pull request complessiva. È possibile aggiungere collegamenti a risorse, ad esempio file, utilizzando il segno @ seguito dal nome del file.

È possibile visualizzare le informazioni sui flussi di lavoro associati avviati dalla creazione di questa pull request scegliendo Overview e quindi esaminando le informazioni nell'area dei dettagli della richiesta Pull in Workflow runs. Per visualizzare l'esecuzione del workflow, scegliete l'esecuzione.

Suggerimento

Se alla filiale hai assegnato un nome diversodevelop, non verrà eseguito automaticamente un flusso di lavoro per creare e testare le modifiche. Se desideri configurarlo, modifica il YAML file per il onPullRequestBuildAndTestflusso di lavoro. Per ulteriori informazioni, consulta Creazione di un flusso di lavoro.

Puoi commentare questa pull request e chiedere agli altri membri del progetto di commentarla. Puoi anche scegliere di aggiungere o modificare revisori facoltativi o obbligatori. Puoi scegliere di apportare ulteriori modifiche al ramo di origine del repository e vedere come tali modifiche confermate creano revisioni per la pull request. Per ulteriori informazioni, vedereRevisione di una pull request, Aggiornamento di una pull requestRevisione del codice con richieste pull in Amazon CodeCatalyst, e. Visualizzazione dello stato e dei dettagli dell'esecuzione del flusso di lavoro

Unire una pull request

Una volta che una pull request è stata esaminata e ha ricevuto l'approvazione dei revisori richiesti, puoi unire il ramo di origine al ramo di destinazione nella console. CodeCatalyst L'unione di una pull request avvierà anche l'esecuzione delle modifiche in tutti i flussi di lavoro associati al ramo di destinazione. In questo tutorial, unirai il ramo di test a main, che avvierà l'esecuzione del flusso di lavoro. onPushToMainDeployPipeline

Per unire una pull request (console)

  1. Nelle richieste Pull, scegli la pull request che hai creato nel passaggio precedente. Nella pull request, scegli Merge.

  2. Scegli tra le strategie di unione disponibili per la pull request. Facoltativamente, seleziona o deseleziona l'opzione per eliminare il ramo di origine dopo aver unito la pull request, quindi scegli Merge. Una volta completata l'unione, lo stato della pull request cambia in Merged e non viene più visualizzato nella visualizzazione predefinita delle pull request. La visualizzazione predefinita mostra le richieste pull con lo stato Aperto. È ancora possibile visualizzare una pull request unita, ma non è possibile approvarla o modificarne lo stato.

    Nota

    Se il pulsante Unisci non è attivo o viene visualizzata l'etichetta Non unibile, significa che un revisore richiesto non ha ancora approvato la pull request oppure la pull request non può essere unita nella console. CodeCatalyst Un revisore che non ha approvato una pull request è indicato da un'icona a forma di orologio in Panoramica nell'area dei dettagli della pull request. Se tutti i revisori obbligatori hanno approvato la pull request ma il pulsante Merge non è ancora attivo, è possibile che si sia verificato un conflitto di unione o che sia stata superata la quota di archiviazione per lo spazio. È possibile risolvere i conflitti di unione per il ramo di destinazione in un ambiente di sviluppo, inviare le modifiche e quindi unire la pull request, oppure è possibile risolvere i conflitti e unirli localmente, quindi inviare il commit che contiene l'unione a. CodeCatalyst Per ulteriori informazioni, consulta Unire una richiesta pull (Git) la documentazione di Git.

Visualizzazione del codice distribuito

Ora è il momento di visualizzare il codice originariamente distribuito che si trovava nel ramo predefinito e le modifiche unite una volta che sono state create, testate e distribuite automaticamente. A tale scopo, puoi tornare alla pagina di panoramica del repository e scegliere il numero accanto all'icona dei flussi di lavoro correlati oppure, nel pannello di navigazione, scegliere CI/CD e quindi scegliere Flussi di lavoro.

Per visualizzare il codice distribuito

  1. In Flussi di lavoro, inonPushToMainDeployPipeline, espandi Esecuzioni recenti.

    Nota

    Questo è il nome predefinito del flusso di lavoro per i progetti creati con il blueprint di applicazione a pagina singola.

  2. L'esecuzione più recente è quella avviata dal conferimento della pull request unita al main branch e probabilmente mostrerà lo stato In corso. Scegli una corsa completata con successo dall'elenco per visualizzare i dettagli di quella corsa.

  3. Scegli Variabili. Copia il valore per App URL. Questo è quello URL per l'applicazione Web a pagina singola distribuita. Apri una nuova scheda del browser e incolla il valore per visualizzare il codice creato e distribuito. Lascia aperta la scheda.

  4. Torna all'elenco dei flussi di lavoro eseguiti e attendi il completamento dell'esecuzione più recente. Quando lo fa, torna alla scheda che hai aperto per visualizzare l'applicazione web e aggiornare il browser. Dovresti vedere le modifiche che hai apportato nella tua pull request unita.

Pulizia delle risorse

Dopo aver esplorato l'utilizzo di un repository di sorgenti e di una pull request, potresti voler rimuovere tutte le risorse che non ti servono. Non puoi eliminare le richieste pull, ma puoi chiuderle. Puoi eliminare tutti i rami che hai creato.

Se non hai più bisogno del repository di origine o del progetto, puoi anche eliminare quelle risorse. Per ulteriori informazioni, consulta Eliminazione di un archivio di origine e Eliminazione di un progetto.