From 3dba7d675fcd9656b31dfaf227ba22317c6b5bbb Mon Sep 17 00:00:00 2001 From: Seth Vargo Date: Thu, 28 Aug 2025 14:53:36 -0400 Subject: [PATCH] Update README to reference v3 --- README.md | 10 +++++----- docs/EXAMPLES.md | 16 ++++++++-------- docs/TROUBLESHOOTING.md | 4 ++-- 3 files changed, 15 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 8816eafb..09f0b4a9 100644 --- a/README.md +++ b/README.md @@ -60,7 +60,7 @@ jobs: steps: - uses: 'actions/checkout@v4' - - uses: 'google-github-actions/auth@v2' + - uses: 'google-github-actions/auth@v3' with: project_id: 'my-project' workload_identity_provider: 'projects/123456789/locations/global/workloadIdentityPools/my-pool/providers/my-provider' @@ -249,7 +249,7 @@ regardless of the authentication mechanism. job_id: steps: - uses: 'actions/checkout@v4' # Must come first! - - uses: 'google-github-actions/auth@v2' + - uses: 'google-github-actions/auth@v3' ``` - `export_environment_variables`: (Optional) If true, the action will export @@ -434,7 +434,7 @@ These instructions use the [gcloud][gcloud] command-line tool. Actions YAML: ```yaml - - uses: 'google-github-actions/auth@v2' + - uses: 'google-github-actions/auth@v3' with: project_id: 'my-project' workload_identity_provider: '...' # "projects/123456789/locations/global/workloadIdentityPools/github/providers/my-repo" @@ -598,7 +598,7 @@ These instructions use the [gcloud][gcloud] command-line tool. Actions YAML: ```yaml - - uses: 'google-github-actions/auth@v2' + - uses: 'google-github-actions/auth@v3' with: service_account: '...' # my-service-account@my-project.iam.gserviceaccount.com workload_identity_provider: '...' # "projects/123456789/locations/global/workloadIdentityPools/github/providers/my-repo" @@ -667,7 +667,7 @@ These instructions use the [gcloud][gcloud] command-line tool. the GitHub Actions YAML: ```yaml - - uses: 'google-github-actions/auth@v2' + - uses: 'google-github-actions/auth@v3' with: credentials_json: '${{ secrets.GOOGLE_CREDENTIALS }}' # Replace with the name of your GitHub Actions secret ``` diff --git a/docs/EXAMPLES.md b/docs/EXAMPLES.md index b798987f..03c4982a 100644 --- a/docs/EXAMPLES.md +++ b/docs/EXAMPLES.md @@ -20,7 +20,7 @@ jobs: id-token: 'write' - id: 'auth' - uses: 'google-github-actions/auth@v2' + uses: 'google-github-actions/auth@v3' with: project_id: 'my-project' workload_identity_provider: 'projects/123456789/locations/global/workloadIdentityPools/my-pool/providers/my-provider' @@ -45,7 +45,7 @@ jobs: contents: 'read' id-token: 'write' - - uses: 'google-github-actions/auth@v2' + - uses: 'google-github-actions/auth@v3' with: project_id: 'my-project' workload_identity_provider: 'projects/123456789/locations/global/workloadIdentityPools/my-pool/providers/my-provider' @@ -56,7 +56,7 @@ jobs: # the service account, specify the 'token_format' parameter and use the # 'accesss_token' output. # - # - uses: 'google-github-actions/auth@v2' + # - uses: 'google-github-actions/auth@v3' # with: # workload_identity_provider: 'projects/123456789/locations/global/workloadIdentityPools/my-pool/providers/my-provider' # service_account: 'my-service-account@my-project.iam.gserviceaccount.com' @@ -79,7 +79,7 @@ jobs: steps: - uses: 'actions/checkout@v4' - - uses: 'google-github-actions/auth@v2' + - uses: 'google-github-actions/auth@v3' with: credentials_json: '${{ secrets.GOOGLE_CREDENTIALS }}' ``` @@ -100,7 +100,7 @@ jobs: - uses: 'actions/checkout@v4' - id: 'auth' - uses: 'google-github-actions/auth@v2' + uses: 'google-github-actions/auth@v3' with: project_id: 'my-project' workload_identity_provider: 'projects/123456789/locations/global/workloadIdentityPools/my-pool/providers/my-provider' @@ -136,7 +136,7 @@ jobs: - uses: 'actions/checkout@v4' - id: 'auth' - uses: 'google-github-actions/auth@v2' + uses: 'google-github-actions/auth@v3' with: token_format: 'access_token' # <-- workload_identity_provider: 'projects/123456789/locations/global/workloadIdentityPools/my-pool/providers/my-provider' @@ -173,7 +173,7 @@ jobs: - uses: 'actions/checkout@v4' - id: 'auth' - uses: 'google-github-actions/auth@v2' + uses: 'google-github-actions/auth@v3' with: token_format: 'id_token' # <-- workload_identity_provider: 'projects/123456789/locations/global/workloadIdentityPools/my-pool/providers/my-provider' @@ -223,7 +223,7 @@ jobs: - uses: 'actions/checkout@v4' - id: 'auth' - uses: 'google-github-actions/auth@v2' + uses: 'google-github-actions/auth@v3' with: workload_identity_provider: 'projects/123456789/locations/global/workloadIdentityPools/my-pool/providers/my-provider' service_account: 'my-service-account@my-project.iam.gserviceaccount.com' diff --git a/docs/TROUBLESHOOTING.md b/docs/TROUBLESHOOTING.md index c138e13e..f7f2cf9d 100644 --- a/docs/TROUBLESHOOTING.md +++ b/docs/TROUBLESHOOTING.md @@ -27,7 +27,7 @@ ```yaml steps: - uses: 'actions/checkout@v4' - - uses: 'google-github-actions/auth@v2' + - uses: 'google-github-actions/auth@v3' ``` 1. Ensure the value for `workload_identity_provider` is the full _Provider_ @@ -266,7 +266,7 @@ Alternatively, you can use the `token_format` parameter of this action to generate an ID token directly: ```yaml -- uses: 'google-github-actions/auth@v2' +- uses: 'google-github-actions/auth@v3' with: workload_identity_provider: ${{ secrets.WIF_PROVIDER }} service_account: ${{ secrets.WIF_SERVICE_ACCOUNT }}