Questa pagina è stata tradotta dall'API Cloud Translation.

GitHub - Automatizzazione della revisione del codice con l'AI generativa

1. Panoramica

In questo lab configurerai il flusso di lavoro di GitHub Actions e lo integrerai con Gemini per automatizzare i passaggi di revisione del codice.

Cosa imparerai a fare

In questo lab imparerai a:

Come aggiungere i passaggi di automazione della revisione del codice GenAI in GitHub
Come eseguire il cli devai localmente per automatizzare le revisioni del codice

Prerequisiti

Questo lab presuppone familiarità con gli ambienti Cloud Console e Cloud Shell.

2. Configurazione e requisiti

Configurazione del progetto cloud

Accedi alla console Google Cloud e crea un nuovo progetto o riutilizzane uno esistente. Se non hai ancora un account Gmail o Google Workspace, devi crearne uno.

Il nome del progetto è il nome visualizzato per i partecipanti al progetto. Si tratta di una stringa di caratteri non utilizzata dalle API di Google. Puoi sempre aggiornarlo.
L'ID progetto è univoco per tutti i progetti Google Cloud ed è immutabile (non può essere modificato dopo essere stato impostato). La console Cloud genera automaticamente una stringa univoca; di solito non ti interessa quale sia. Nella maggior parte dei codelab, dovrai fare riferimento al tuo ID progetto (in genere identificato come PROJECT_ID). Se l'ID generato non ti piace, puoi generarne un altro casuale. In alternativa, puoi provare il tuo e vedere se è disponibile. Non può essere modificato dopo questo passaggio e rimane invariato per tutta la durata del progetto.
Per tua informazione, esiste un terzo valore, un Numero progetto, utilizzato da alcune API. Scopri di più su tutti e tre questi valori nella documentazione.

Successivamente, dovrai abilitare la fatturazione nella console Cloud per utilizzare le API/risorse Cloud. La partecipazione a questo codelab non ha costi, o quasi. Per arrestare le risorse ed evitare di incorrere in fatturazione al termine di questo tutorial, puoi eliminare le risorse che hai creato o il progetto. I nuovi utenti di Google Cloud sono idonei al programma Prova senza costi di 300$.

Configurazione dell'ambiente

Apri la chat di Gemini.

In alternativa, digita "Chiedi a Gemini" nella barra di ricerca.

Abilita l'API Cloud AI Companion:

Fai clic su "Start chatting" e segui una delle domande di esempio o digita il tuo prompt per provarlo.

Prompt da provare:

Spiega Cloud Run in 5 punti chiave.
Sei un Product Manager di Google Cloud Run e devi spiegare Cloud Run a uno studente in 5 brevi punti chiave.
Sei un Product Manager di Google Cloud Run e devi spiegare Cloud Run a uno sviluppatore Kubernetes certificato in 5 brevi punti chiave.
Sei un Product Manager di Google Cloud Run. Spiega a uno sviluppatore senior quando utilizzeresti Cloud Run rispetto a GKE in 5 brevi punti chiave.

Consulta la guida ai prompt per scoprire di più su come scrivere prompt migliori.

In che modo Gemini for Google Cloud utilizza i tuoi dati

Impegno di Google per la privacy

Google è stata una delle prime aziende del settore a pubblicare un impegno in materia di privacy AI/ML, che illustra la nostra convinzione che i clienti debbano disporre del massimo livello di sicurezza e controllo sui propri dati archiviati nel cloud.

Dati che invii e ricevi

Le domande che fai a Gemini, incluse le informazioni di input o il codice che invii a Gemini per l'analisi o il completamento, sono chiamate prompt. Le risposte o i completamenti di codice che ricevi da Gemini sono chiamati risposte. Gemini non utilizza i tuoi prompt o le relative risposte come dati per addestrare i propri modelli.

Crittografia dei prompt

Quando invii prompt a Gemini, i tuoi dati vengono criptati in transito come input al modello sottostante in Gemini.

Dati del programma generati da Gemini

Gemini viene addestrato sul codice proprietario di Google Cloud e su codice di terze parti selezionato. Sei responsabile della sicurezza, dei test e dell'efficacia del tuo codice, incluse eventuali operazioni di completamento, generazione o analisi del codice offerte da Gemini.

Scopri di più su come Google gestisce i tuoi prompt.

3. Opzioni per testare i prompt

Se vuoi modificare/ampliare i prompt devai cli esistenti, hai a disposizione diverse opzioni.

Vertex AI Studio

Vertex AI Studio fa parte della piattaforma Vertex AI di Google Cloud, progettata specificamente per semplificare e accelerare lo sviluppo e l'utilizzo dei modelli di IA generativa.

Google AI Studio

Google AI Studio è uno strumento basato sul web per la prototipazione e la sperimentazione della progettazione di prompt e dell'API Gemini.

App web Gemini (gemini.google.com)

L'app web Google Gemini (gemini.google.com) è uno strumento basato sul web progettato per aiutarti a esplorare e utilizzare la potenza dei modelli di IA di Gemini di Google.

App mobile Google Gemini per Android e app Google su iOS

4. Crea service account

Attiva Cloud Shell facendo clic sull'icona a destra della barra di ricerca.

Nel terminale aperto, abilita i servizi richiesti per utilizzare le API Vertex AI e la chat Gemini.

gcloud services enable \
    aiplatform.googleapis.com \
    cloudaicompanion.googleapis.com \
    cloudresourcemanager.googleapis.com \
    secretmanager.googleapis.com

Se ti viene chiesto di autorizzare, fai clic su "Autorizza" per continuare.

Esegui i seguenti comandi per creare un nuovo account di servizio e le relative chiavi.

Utilizzerai questo account di servizio per effettuare chiamate API all'API Vertex AI Gemini dalle pipeline CICD.

PROJECT_ID=$(gcloud config get-value project)
SERVICE_ACCOUNT_NAME='vertex-client'
DISPLAY_NAME='Vertex Client'
KEY_FILE_NAME='vertex-client-key'

gcloud iam service-accounts create $SERVICE_ACCOUNT_NAME --display-name "$DISPLAY_NAME"

gcloud projects add-iam-policy-binding $PROJECT_ID --member="serviceAccount:$SERVICE_ACCOUNT_NAME@$PROJECT_ID.iam.gserviceaccount.com" --role="roles/aiplatform.admin" --condition None

gcloud projects add-iam-policy-binding $PROJECT_ID --member="serviceAccount:$SERVICE_ACCOUNT_NAME@$PROJECT_ID.iam.gserviceaccount.com" --role="roles/secretmanager.secretAccessor" --condition None

gcloud iam service-accounts keys create $KEY_FILE_NAME.json --iam-account=$SERVICE_ACCOUNT_NAME@$PROJECT_ID.iam.gserviceaccount.com

5. Crea un fork del repository GitHub nel tuo repository GitHub personale

Vai a https://github.com/GoogleCloudPlatform/genai-for-developers/fork e seleziona il tuo ID utente GitHub come proprietario.

Deseleziona l'opzione per copiare solo il ramo "principale".

Fai clic su "Create fork".

6. Abilita il flusso di lavoro GitHub Actions

Apri il repository GitHub sottoposto a fork nel browser e passa alla scheda "Actions" per attivare i flussi di lavoro.

7. Aggiungi secret del repository

Crea un secret del repository in "Settings / Secrets and variables / Actions" nel repository GitHub sottoposto a fork.

Aggiungi il secret del repository con il nome "GOOGLE_API_CREDENTIALS".

Passa alla finestra/scheda della shell Google Cloud ed esegui il comando seguente nel terminale Cloud Shell.

cat ~/vertex-client-key.json

Copia il contenuto del file e incollalo come valore per il secret.

Aggiungi il segreto PROJECT_ID con il tuo ID progetto Qwiklabs come valore:

8. Esegui il workflow GitHub Actions

Vai al tuo repository GitHub nel browser ed esegui il flusso di lavoro.

Il flusso di lavoro è configurato per l'esecuzione tramite push del codice o esecuzione manuale.

Esamina i risultati:

Risultati del comando di copertura del test:

devai review testcoverage -c ${{ github.workspace }}/sample-app/src/main/java/anthos/samples/bankofanthos/balancereader

Risultati del comando di revisione del codice:

devai review code -c ${{ github.workspace }}/sample-app/src/main/java/anthos/samples/bankofanthos/balancereader

Risultati del comando di revisione del rendimento:

devai review performance -c ${{ github.workspace }}/sample-app/src/main/java/anthos/samples/bankofanthos/balancereader

Risultati del comando di revisione della sicurezza:

devai review security -c ${{ github.workspace }}/sample-app/src/main/java/anthos/samples/bankofanthos/balancereader

I blocchi esaminano i risultati del comando:

devai review blockers -c ${{ github.workspace }}/sample-app/pom.xml

9. Clona il repository

Torna al terminale Cloud Shell e clona il repository.

Sostituisci YOUR-GITHUB-USERID con il tuo ID utente GitHub prima di eseguire i comandi.

git clone https://github.com/YOUR-GITHUB-USERID/genai-for-developers.git

Cambia cartella e apri il file di flusso di lavoro nell'editor di Cloud Shell.

cd genai-for-developers

cloudshell edit .github/workflows/devai-review.yml

Attendi che il file di configurazione venga visualizzato nell'IDE.

10. Attivare Gemini Code Assist

Fai clic sull'icona "Gemini" nell'angolo in basso a destra .

Fai clic su "Login to Google Cloud" e "Select a Google Cloud Project".

Nella finestra popup, seleziona il tuo progetto Qwiklabs.

11. Spiega il codice con Gemini Code Assist

Fai clic con il tasto destro del mouse in un punto qualsiasi del file devai-review.yml e seleziona Gemini Code Assist > Explain.

Spiegazione della recensione:

12. Esegui DEVAI CLI in locale

Torna al terminale Cloud Shell ed esegui i comandi riportati di seguito per installare devai in locale.

pip3 install devai-cli

Il client è stato installato, ma non è presente nel PATH.

WARNING: The script devai is installed in '/home/student_00_478dfeb8df15/.local/bin' which is not on PATH.
  Consider adding this directory to PATH or, if you prefer to suppress this warning, use --no-warn-script-location.

Esegui il comando seguente per aggiornare la variabile di ambiente PATH. Sostituisci con il nome della home directory dell'utente. Ad esempio: student_00_478dfeb8df15

export PATH=$PATH:/home/YOUR-USER-HOME-FOLDER/.local/bin

Esegui il comando devai cli per eseguire la revisione del codice in locale. Esamina l'output dell'interfaccia a riga di comando.

export PROJECT_ID=$(gcloud config get-value project)
export LOCATION=us-central1

cd ~/genai-for-developers

devai review code -c ./sample-app/src/main/java/anthos/samples/bankofanthos/balancereader

Apri lo script di revisione eseguendo il comando seguente:

cloudshell edit devai-cli/src/devai/commands/review.py

Fai clic con il tasto destro del mouse in un punto qualsiasi del file review.py e seleziona Gemini Code Assist > Explain.

Esamina la spiegazione.

13. Sviluppo dell'interfaccia a riga di comando DevAI

In questa sezione apporterai modifiche a devai cli.

Per iniziare, configura l'ambiente virtuale Python, installa i requisiti ed esegui il comando di esempio.

cd ~/genai-for-developers/devai-cli
python3 -m venv venv
. venv/bin/activate
pip3 install -r src/requirements.txt
pip3 install --editable ./src
devai echo

Esegui di nuovo il comando di revisione del codice per verificare che tutto funzioni correttamente:

devai review code -c ~/genai-for-developers/sample-app/src/main/java/anthos/samples/bankofanthos/balancereader

Esamina i risultati utilizzando l'anteprima di Markdown nell'editor di Cloud Shell.

Crea un nuovo file e incolla la risposta di Gemini.

Quindi utilizza la tavolozza dei comandi e seleziona "Markdown: Open Preview".

14. Esplora i comandi devai cli

Comando di revisione del codice

devai review code -c ~/genai-for-developers/sample-app/src/main/java

Comando di revisione del rendimento

devai review performance -c ~/genai-for-developers/sample-app/src/main/java

Comando di revisione della sicurezza

devai review security -c ~/genai-for-developers/sample-app/src/main/java

Comando di revisione della copertura del test

devai review testcoverage -c ~/genai-for-developers/sample-app/src

Comandi di revisione degli elementi che bloccano

devai review blockers -c ~/genai-for-developers/sample-app/pom.xml
devai review blockers -c ~/genai-for-developers/sample-app/setup.md

Revisione e riepilogo di immagini/diagrammi:

Diagramma di input[~/genai-for-developers/images/extension-diagram.png]:

Rivedi il comando:

devai review image \
  -f ~/genai-for-developers/images/extension-diagram.png \
  -p "Review and summarize this diagram"

Output:

The diagram outlines a process for conducting local code reviews using a VS Code extension or CLI, leveraging Google Cloud's Vertex AI (Gemini Pro) for generating review prompts.

**Process Flow:**

1. **Code Style Check:** Developers initiate the process by checking their code for adherence to pre-defined style guidelines.
2. **Prompt Generation:** The VS Code extension/CLI sends the code to Vertex AI (Gemini Pro) on Google Cloud.
3. **Vertex AI Review:** Vertex AI analyzes the code and generates relevant review prompts.
4. **Local Review:** The prompts are sent back to the developer's IDE for their consideration.
5. **Optional Actions:** Developers can optionally:
- Create new JIRA issues directly from the IDE based on the review prompts.
- Generate new issues in a GitLab repository.

**Key Components:**

* **VS Code Extension/CLI:** Tools facilitating the interaction with Vertex AI and potential integrations with JIRA and GitLab.
* **Vertex AI (Gemini Pro):** Google Cloud's generative AI service responsible for understanding the code and generating meaningful review prompts.
* **Google Cloud Secret Manager:** Securely stores API keys and access tokens required to authenticate and interact with Google Cloud services.
* **JIRA/GitLab (Optional):** Issue tracking and project management tools that can be integrated for a streamlined workflow.

**Benefits:**

* **Automated Review Assistance:** Leveraging AI to generate review prompts saves time and improves the consistency and quality of code reviews.
* **Local Development:** The process empowers developers to conduct reviews locally within their familiar IDE.
* **Integration Options:** The flexibility to integrate with project management tools like JIRA and GitLab streamlines workflow and issue tracking.

Analisi delle differenze tra immagini:

devai review imgdiff \
  -c ~/genai-for-developers/images/devai-api.png \
  -t ~/genai-for-developers/images/devai-api-slack.png

Output:

The following UI elements are missing in the "AFTER UPGRADE STATE" image compared to the "BEFORE UPGRADE STATE" image:

1. **Slack:** The entire Slack element, including the icon, "Team channel" label, and the arrow indicating interaction, is absent in the AFTER UPGRADE image. 
2. **Storage Bucket:**  The "Storage Bucket" element with its icon and "PDFs" label is missing in the AFTER UPGRADE image. 
3. **"GenAI Agents" label in Vertex AI block:** The BEFORE UPGRADE image has "Vertex AI Agents" and "GenAI Agent" labels within the Vertex AI block, while the AFTER UPGRADE image only has "Vertex AI."
4. **"Open JIRA Issue" and "Team Project" labels:** In the BEFORE UPGRADE image, these labels are connected to the JIRA block with an arrow. These are missing in the AFTER UPGRADE image.

**Decision Explanation:**

The analysis is based on a direct visual comparison of the two provided images, noting the presence and absence of specific UI elements and their associated labels. The elements listed above are present in the BEFORE UPGRADE image but absent in the AFTER UPGRADE image.

Comando di generazione della documentazione:

devai document readme -c ~/genai-for-developers/sample-app/src/main/

Output:

# Bank of Anthos - Balance Reader Service

## Description

The Balance Reader service is a component of the Bank of Anthos sample application. It provides a REST endpoint for retrieving the current balance of a user account. This service demonstrates key concepts for building microservices with Spring Boot and deploying them to a Kubernetes cluster.

## Features
...

Esamina i comandi devai cli disponibili nell'editor di Cloud Shell:

cloudshell edit ~/genai-for-developers/devai-cli/README.md

In alternativa, consulta il file README.md nel repository GitHub.

15. Complimenti!

Complimenti, hai completato il codelab.

Argomenti trattati:

Aggiunta di passaggi di automazione della revisione del codice GenAI in GitHub
Esegui l'interfaccia a riga di comando devai in locale

Passaggi successivi

Saranno presto disponibili altre sessioni pratiche.

Esegui la pulizia

Per evitare che al tuo account Google Cloud vengano addebitati costi relativi alle risorse utilizzate in questo tutorial, elimina il progetto che contiene le risorse oppure mantieni il progetto ed elimina le singole risorse.

Elimina il progetto

Il modo più semplice per eliminare la fatturazione è eliminare il progetto che hai creato per il tutorial.