GitHub - GenAI की मदद से कोड की समीक्षा करने की सुविधा को ऑटोमेट करना

1. खास जानकारी

इस लैब में, आपको GitHub ऐक्शन वर्कफ़्लो सेट अप करना होगा. साथ ही, कोड की समीक्षा के चरणों को ऑटोमेट करने के लिए, इसे Gemini के साथ इंटिग्रेट करना होगा.

आपको क्या सीखने को मिलेगा

इस लैब में, आपको ये काम करने का तरीका पता चलेगा:

• GitHub में GenAI कोड की समीक्षा करने की ऑटोमेशन प्रोसेस के चरणों को जोड़ने का तरीका
• कोड की समीक्षा अपने-आप करने के लिए, devai क्लाइंट-लाइन इंटरफ़ेस (सीएलआई) को स्थानीय तौर पर चलाने का तरीका

ज़रूरी शर्तें

• इस लैब में यह माना गया है कि आपको Cloud Console और Cloud Shell के एनवायरमेंट के बारे में पता है.

2. सेटअप और ज़रूरी शर्तें

Cloud प्रोजेक्ट का सेटअप

1. Google Cloud Console में साइन इन करें और नया प्रोजेक्ट बनाएं या किसी मौजूदा प्रोजेक्ट का फिर से इस्तेमाल करें. अगर आपके पास पहले से कोई Gmail या Google Workspace खाता नहीं है, तो आपको एक खाता बनाना होगा.

• प्रोजेक्ट का नाम, इस प्रोजेक्ट में हिस्सा लेने वाले लोगों के लिए डिसप्ले नेम होता है. यह एक वर्ण स्ट्रिंग है, जिसका इस्तेमाल Google API नहीं करते. इसे कभी भी अपडेट किया जा सकता है.
• प्रोजेक्ट आईडी, Google Cloud के सभी प्रोजेक्ट के लिए यूनीक होता है. साथ ही, इसे सेट करने के बाद बदला नहीं जा सकता. Cloud Console, अपने-आप एक यूनीक स्ट्रिंग जनरेट करता है. आम तौर पर, आपको यह जानने की ज़रूरत नहीं होती कि यह स्ट्रिंग क्या है. ज़्यादातर कोडलैब में, आपको अपने प्रोजेक्ट आईडी का रेफ़रंस देना होगा. आम तौर पर, इसे PROJECT_ID के तौर पर पहचाना जाता है. अगर आपको जनरेट किया गया आईडी पसंद नहीं आता है, तो कोई दूसरा आईडी जनरेट किया जा सकता है. इसके अलावा, आपके पास खुद का कोई दूसरा नाम चुनने का विकल्प भी है. इस चरण के बाद, इसे बदला नहीं जा सकता. यह प्रोजेक्ट के दौरान बना रहता है.
• आपकी जानकारी के लिए बता दें कि तीसरी वैल्यू, प्रोजेक्ट नंबर होती है. इसका इस्तेमाल कुछ एपीआई करते हैं. दस्तावेज़ में इन तीनों वैल्यू के बारे में ज़्यादा जानें.

चेतावनी: प्रोजेक्ट आईडी दुनिया भर में यूनीक होता है. इसे चुनने के बाद, कोई दूसरा व्यक्ति इसका इस्तेमाल नहीं कर सकता. उस आईडी का इस्तेमाल सिर्फ़ आपने किया हो. प्रोजेक्ट मिटाने के बाद भी, आईडी का फिर से इस्तेमाल नहीं किया जा सकता

ध्यान दें: अगर Gmail खाते का इस्तेमाल किया जा रहा है, तो डिफ़ॉल्ट तौर पर संगठन की जानकारी को कोई संगठन नहीं पर सेट रहने दें. अगर Google Workspace खाते का इस्तेमाल किया जा रहा है, तो अपने संगठन के लिए कोई ऐसी जगह चुनें जो आपके काम की हो.

2. इसके बाद, आपको Cloud के संसाधनों/एपीआई का इस्तेमाल करने के लिए, Cloud Console में बिलिंग की सुविधा चालू करनी होगी. इस कोडलैब को चलाने के लिए, आपसे कोई शुल्क नहीं लिया जाएगा. इस ट्यूटोरियल के बाद बिलिंग से बचने के लिए, बनाए गए संसाधनों को बंद किया जा सकता है या प्रोजेक्ट को मिटाया जा सकता है. Google Cloud के नए उपयोगकर्ता, 300 डॉलर के मुफ़्त ट्रायल वाले कार्यक्रम में शामिल हो सकते हैं.

एनवायरमेंट सेटअप करना

Gemini Chat खोलें.

इसके अलावा, खोज बार में "Gemini से पूछें" लिखें.

Cloud AI Companion API को चालू करने के लिए:

"Start chatting" पर क्लिक करें और सैंपल के तौर पर दिए गए सवालों में से किसी एक को फ़ॉलो करें या इसे आज़माने के लिए अपना प्रॉम्प्ट टाइप करें.

ये प्रॉम्प्ट आज़माएँ:

• Cloud Run के बारे में पांच मुख्य बातों में बताएं.
• आप Google Cloud Run के प्रॉडक्ट मैनेजर हैं. किसी छात्र को Cloud Run के बारे में पांच मुख्य बातों में बताएं.
• आप Google Cloud Run के प्रॉडक्ट मैनेजर हैं. आपको सर्टिफ़ाइड Kubernetes डेवलपर को पांच मुख्य बातों में Cloud Run के बारे में बताना है.
• आप Google Cloud Run के प्रॉडक्ट मैनेजर हैं. आपको किसी सीनियर डेवलपर को पांच मुख्य बातों में यह बताना है कि Cloud Run और GKE में से किसका इस्तेमाल कब किया जाना चाहिए.

बेहतर प्रॉम्प्ट लिखने के बारे में ज़्यादा जानने के लिए, प्रॉम्प्ट के लिए गाइड देखें.

Google Cloud के लिए Gemini आपके डेटा का इस्तेमाल कैसे करता है

निजता को लेकर Google की प्रतिबद्धता

Google, इंडस्ट्री में उन कंपनियों में से एक है जिन्होंने एआई/एमएल से जुड़ी निजता से जुड़ी प्रतिबद्धता पब्लिश की है. इससे यह पता चलता है कि हमारे हिसाब से, ग्राहकों को क्लाउड में सेव किए गए अपने डेटा पर सबसे ज़्यादा सुरक्षा और कंट्रोल मिलना चाहिए.

आपका सबमिट किया गया और पाया गया डेटा

Gemini से पूछे गए सवालों को प्रॉम्प्ट कहा जाता है. इनमें, विश्लेषण करने या पूरा करने के लिए, Gemini को सबमिट की गई कोई भी इनपुट जानकारी या कोड भी शामिल है. Gemini से मिलने वाले जवाबों या कोड को पूरा करने की सुविधा को जवाब कहा जाता है. Gemini, अपने मॉडल को ट्रेनिंग देने के लिए, आपके प्रॉम्प्ट या उनके जवाबों का इस्तेमाल नहीं करता है.

प्रॉम्प्ट को एन्क्रिप्ट (सुरक्षित) करना

Gemini में प्रॉम्प्ट सबमिट करने पर, Gemini में मौजूद मॉडल के इनपुट के तौर पर, आपका डेटा एन्क्रिप्ट (सुरक्षित) किया जाता है.

Gemini से जनरेट किया गया प्रोग्राम डेटा

Gemini को पहले पक्ष के Google Cloud कोड के साथ-साथ, चुने गए तीसरे पक्ष के कोड पर ट्रेनिंग दी गई है. अपने कोड की सुरक्षा, जांच, और असरदार होने की ज़िम्मेदारी आपकी है. इसमें, Gemini की मदद से पूरा किया गया कोड, जनरेट किया गया कोड या उसका विश्लेषण भी शामिल है.

Google आपके प्रॉम्प्ट को कैसे मैनेज करता है, इसके बारे में ज़्यादा जानें.

3. प्रॉम्प्ट की जांच करने के विकल्प

अगर आपको मौजूदा devai cli प्रॉम्प्ट में बदलाव करना है या उन्हें बढ़ाना है, तो आपके पास इसके कई विकल्प हैं.

• Vertex AI Studio

Vertex AI Studio, Google Cloud के Vertex AI प्लैटफ़ॉर्म का हिस्सा है. इसे खास तौर पर, जनरेटिव एआई मॉडल को आसानी से डेवलप करने और इस्तेमाल करने के लिए डिज़ाइन किया गया है.

• Google AI Studio

Google AI Studio, वेब पर काम करने वाला एक टूल है. इसका इस्तेमाल, प्रॉम्प्ट इंजीनियरिंग और Gemini API के साथ प्रोटोटाइप बनाने और एक्सपेरिमेंट करने के लिए किया जाता है.

• Gemini का वेब ऐप्लिकेशन (gemini.google.com)

Google Gemini का वेब ऐप्लिकेशन (gemini.google.com), वेब पर काम करने वाला टूल है. इसे Google के Gemini एआई मॉडल को एक्सप्लोर करने और उनका इस्तेमाल करने में आपकी मदद करने के लिए डिज़ाइन किया गया है.

• Android के लिए Google Gemini मोबाइल ऐप्लिकेशन और iOS पर Google ऐप्लिकेशन

4. सेवा खाता बनाएं

सर्च बार की दाईं ओर मौजूद आइकॉन पर क्लिक करके, Cloud Shell चालू करें.

खुले हुए टर्मिनल में, Vertex AI API और Gemini Chat का इस्तेमाल करने के लिए ज़रूरी सेवाएं चालू करें.

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

अगर आपसे अनुमति देने के लिए कहा जाता है, तो जारी रखने के लिए "अनुमति दें" पर क्लिक करें.

नया सेवा खाता और कुंजियां बनाने के लिए, ये कमांड चलाएं.

आपको इस सेवा खाते का इस्तेमाल, CICD पाइपलाइन से Vertex AI Gemini API को एपीआई कॉल करने के लिए करना होगा.

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. GitHub रिपॉज़िटरी को अपने निजी GitHub रिपॉज़िटरी में फ़ोर्क करना

https://github.com/GoogleCloudPlatform/genai-for-developers/fork पर जाएं और मालिक के तौर पर अपना GitHub उपयोगकर्ता आईडी चुनें.

सिर्फ़ "मुख्य" शाखा को कॉपी करने के विकल्प से सही का निशान हटाएं.

"Create fork" पर क्लिक करें.

6. GitHub Actions वर्कफ़्लो चालू करना

ब्राउज़र में फ़ोक्ड किया गया GitHub रिपॉज़िटरी खोलें और वर्कफ़्लो चालू करने के लिए, "Actions" टैब पर स्विच करें.

7. डेटा स्टोर करने की जगह के लिए पासकोड जोड़ना

फ़ोक्ड किए गए GitHub रिपॉज़िटरी में "Settings / Secrets and variables / Actions" में जाकर, रिपॉज़िटरी का पासवर्ड बनाएं.

"GOOGLE_API_CREDENTIALS" नाम वाला रिपॉज़िटरी सीक्रेट जोड़ें.

Google Cloud Shell विंडो/टैब पर स्विच करें और Cloud Shell टर्मिनल में नीचे दिया गया निर्देश चलाएं.

cat ~/vertex-client-key.json

फ़ाइल का कॉन्टेंट कॉपी करें और उसे सीक्रेट की वैल्यू के तौर पर चिपकाएं.

वैल्यू के तौर पर, अपने Qwiklabs प्रोजेक्ट आईडी के साथ PROJECT_ID सीक्रेट जोड़ें:

8. GitHub Actions वर्कफ़्लो चलाना

ब्राउज़र में अपनी GitHub रिपॉज़िटरी पर जाएं और वर्कफ़्लो चलाएं.

वर्कफ़्लो को कोड पुश या मैन्युअल तरीके से चलाने के लिए कॉन्फ़िगर किया गया है.

नतीजों की समीक्षा करें:

कवरेज की जांच करने वाले निर्देश के नतीजे:

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

कोड की समीक्षा करने वाले निर्देश के नतीजे:

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

परफ़ॉर्मेंस की समीक्षा करने वाले निर्देश के नतीजे:

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

सुरक्षा समीक्षा के लिए दिए गए निर्देश के नतीजे:

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

ब्लॉक करने वाले, कमांड के नतीजों की समीक्षा करते हैं:

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

9. डेटा स्टोर करने की जगह को क्लोन करना

Cloud Shell टर्मिनल पर वापस जाएं और रिपॉज़िटरी को क्लोन करें.

निर्देश चलाने से पहले, YOUR-GITHUB-USERID को अपने GitHub यूज़र आईडी में बदलें.

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

फ़ोल्डर बदलें और Cloud Shell एडिटर में वर्कफ़्लो फ़ाइल खोलें.

cd genai-for-developers

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

जब तक आईडीई में कॉन्फ़िगरेशन फ़ाइल न दिखे, तब तक इंतज़ार करें.

10. Gemini Code Assist की सुविधा चालू करना

सबसे नीचे दाएं कोने में मौजूद, "Gemini" आइकॉन पर क्लिक करें,

"Login to Google Cloud" और "Select a Google Cloud Project" पर क्लिक करें.

पॉप-अप विंडो में, अपना Qwiklabs प्रोजेक्ट चुनें.

11. Gemini Code Assist की मदद से कोड के बारे में जानकारी पाना

devai-review.yml फ़ाइल में कहीं भी राइट क्लिक करें और Gemini Code Assist > Explain इसे चुनें.

समीक्षा की जानकारी:

12. DEVAI CLI को स्थानीय तौर पर चलाना

Cloud Shell टर्मिनल पर वापस जाएं और devai को स्थानीय तौर पर इंस्टॉल करने के लिए, नीचे दिए गए निर्देशों का पालन करें.

pip3 install devai-cli

cli इंस्टॉल हो गया है, लेकिन यह 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.

PATH एनवायरमेंट वैरिएबल को अपडेट करने के लिए, नीचे दिया गया कमांड चलाएं. उपयोगकर्ता के होम फ़ोल्डर के नाम से बदलें. उदाहरण के लिए: student_00_478dfeb8df15

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

स्थानीय तौर पर कोड की समीक्षा करने के लिए, devai cli कमांड चलाएं. सीएलआई के आउटपुट की समीक्षा करें.

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

समीक्षा स्क्रिप्ट खोलने के लिए, यहां दिया गया कमांड चलाएं:

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

review.py फ़ाइल में कहीं भी राइट क्लिक करें और Gemini Code Assist > Explain इसे चुनें.

वजह देखें.

13. DevAI सीएलआई डेवलपमेंट

इस सेक्शन में, आपको devai cli में बदलाव करने होंगे.

शुरू करने के लिए, python virtualenv सेट अप करें, ज़रूरी शर्तें इंस्टॉल करें, और सैंपल कमांड चलाएं.

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

कोड की समीक्षा करने वाले कमांड को फिर से चलाकर देखें कि सब कुछ ठीक से काम कर रहा है या नहीं:

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

Cloud Shell एडिटर में, Markdown की झलक का इस्तेमाल करके नतीजों की समीक्षा करें.

एक नई फ़ाइल बनाएं और Gemini का जवाब चिपकाएं.

इसके बाद, कमांड पैलेट का इस्तेमाल करके "Markdown: Open Preview" चुनें.

14. devai cli के निर्देशों के बारे में जानकारी

कोड की समीक्षा करने का निर्देश

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

परफ़ॉर्मेंस की समीक्षा करने का निर्देश

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

सुरक्षा की समीक्षा करने का निर्देश

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

कवरेज की समीक्षा करने का निर्देश

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

ब्लॉक करने वाले टूल की समीक्षा करने के लिए निर्देश

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

इमेज/डायग्राम की समीक्षा और खास जानकारी:

डायग्राम डालें[~/genai-for-developers/images/extension-diagram.png]:

निर्देश की समीक्षा करें:

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

आउटपुट:

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.

इमेज के अंतर का विश्लेषण:

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

आउटपुट:

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.

दस्तावेज़ जनरेट करने का निर्देश:

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

आउटपुट:

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

Cloud Shell Editor में, devai cli के उपलब्ध निर्देशों की समीक्षा करें:

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

इसके अलावा, GitHub रिपॉज़िटरी में README.md देखें.

15. बधाई हो!

बधाई हो, आपने कोडलैब पूरा कर लिया है!

हमने इन विषयों पर जानकारी दी है:

• GitHub में GenAI कोड की समीक्षा के ऑटोमेशन के चरण जोड़ना
• devai cli को स्थानीय तौर पर चलाना

आगे क्या करना है:

• इस तरह के और भी सेशन आने वाले हैं!

व्यवस्थित करें

इस ट्यूटोरियल में इस्तेमाल किए गए संसाधनों के लिए, अपने Google Cloud खाते से शुल्क न लिया जाए, इसके लिए संसाधनों वाले प्रोजेक्ट को मिटाएं या प्रोजेक्ट को बनाए रखें और अलग-अलग संसाधनों को मिटाएं.

प्रोजेक्ट मिटाना

बिलिंग की सुविधा बंद करने का सबसे आसान तरीका, ट्यूटोरियल के लिए बनाया गया प्रोजेक्ट मिटाना है.

©2024 Google LLC. सभी अधिकार सुरक्षित हैं. Google और Google का लोगो, Google LLC के ट्रेडमार्क हैं. अन्य सभी कंपनी और उत्पाद नाम उनसे संबद्ध कंपनियों के ट्रेडमार्क हो सकते हैं.