Skip to content

Commit 1d2646a

Browse files
authored
feat(docs): Update authentication documentation (#84)
This commit updates the authentication documentation to clarify the use of Workload Identity Federation and Gemini Code Assist. The following changes are included: - Added and to the list of required variables for Workload Identity Federation. - Updated the workflow configuration examples to use the new variables. - Improved the clarity and consistency of the documentation.
1 parent d44d269 commit 1d2646a

1 file changed

Lines changed: 14 additions & 10 deletions

File tree

docs/authentication.md

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -148,6 +148,7 @@ After running the `setup_workload_identity.sh` script, add the following variabl
148148
| Variable Name | Description |
149149
| --------------------------- | ---------------------------------------------------- |
150150
| `GCP_WIF_PROVIDER` | The resource name of the Workload Identity Provider. |
151+
| `SERVICE_ACCOUNT_EMAIL` | The service account with the required permissions. |
151152
| `GOOGLE_CLOUD_PROJECT` | Your Google Cloud project ID. |
152153
| `GOOGLE_CLOUD_LOCATION` | Your Google Cloud project Location. |
153154
| `GOOGLE_GENAI_USE_VERTEXAI` | Set to `true` to use Vertex AI. |
@@ -157,11 +158,12 @@ After running the `setup_workload_identity.sh` script, add the following variabl
157158
```yaml
158159
- uses: google-github-actions/run-gemini-cli@main
159160
with:
160-
prompt: "Explain this code"
161-
gcp_workload_identity_provider: ${{ vars.GCP_WIF_PROVIDER }}
162-
gcp_project_id: ${{ vars.GOOGLE_CLOUD_PROJECT }}
163-
gcp_location: ${{ vars.GOOGLE_CLOUD_LOCATION }}
164-
use_vertex_ai: 'true'
161+
prompt: 'Explain this code'
162+
gcp_workload_identity_provider: '${{ vars.GCP_WIF_PROVIDER }}'
163+
gcp_service_account: '${{ vars.SERVICE_ACCOUNT_EMAIL }}'
164+
gcp_project_id: '${{ vars.GOOGLE_CLOUD_PROJECT }}'
165+
gcp_location: '${{ vars.GOOGLE_CLOUD_LOCATION }}'
166+
use_vertex_ai: '${{ vars.GOOGLE_GENAI_USE_VERTEXAI }}'
165167
```
166168
167169
### Connecting to Gemini Code Assist
@@ -180,6 +182,7 @@ After running the `setup_workload_identity.sh` script, add the following variabl
180182
| ----------------------- | ------------------------------------------------------- |
181183
| `GCP_WIF_PROVIDER` | The resource name of the Workload Identity Provider. |
182184
| `GOOGLE_CLOUD_PROJECT` | Your Google Cloud project ID. |
185+
| `GOOGLE_CLOUD_LOCATION` | Your Google Cloud project Location. |
183186
| `SERVICE_ACCOUNT_EMAIL` | The email of the service account for Code Assist. |
184187
| `GOOGLE_GENAI_USE_GCA` | Set to `true` to authenticate using Gemini Code Assist. |
185188

@@ -188,11 +191,12 @@ After running the `setup_workload_identity.sh` script, add the following variabl
188191
```yaml
189192
- uses: google-github-actions/run-gemini-cli@main
190193
with:
191-
prompt: "Explain this code"
192-
gcp_workload_identity_provider: ${{ vars.GCP_WIF_PROVIDER }}
193-
gcp_project_id: ${{ vars.GOOGLE_CLOUD_PROJECT }}
194-
gcp_service_account: ${{ vars.SERVICE_ACCOUNT_EMAIL }}
195-
use_gemini_code_assist: 'true'
194+
prompt: 'Explain this code'
195+
gcp_workload_identity_provider: '${{ vars.GCP_WIF_PROVIDER }}'
196+
gcp_service_account: '${{ vars.SERVICE_ACCOUNT_EMAIL }}'
197+
gcp_project_id: '${{ vars.GOOGLE_CLOUD_PROJECT }}'
198+
gcp_location: '${{ vars.GOOGLE_CLOUD_LOCATION }}'
199+
use_gemini_code_assist: '${{ vars.GOOGLE_GENAI_USE_GCA }}'
196200
```
197201

198202
## Additional Resources

0 commit comments

Comments
 (0)