From 9cf496b575d1c15b0ecb49ab30463b7cf73a2d79 Mon Sep 17 00:00:00 2001 From: Seth Vargo Date: Tue, 8 Nov 2022 12:00:36 -0500 Subject: [PATCH] Switch to auth@v1 (#238) There's a chicken-and-egg problem here where we want to have the docs reflect v1 (so the github marketplace shows the right thing), but we can't cut v1 until the docs are updated. --- README.md | 20 ++++++++++---------- docs/TROUBLESHOOTING.md | 2 +- 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 44e64430..0a5bcd44 100644 --- a/README.md +++ b/README.md @@ -68,7 +68,7 @@ jobs: - id: 'auth' name: 'Authenticate to Google Cloud' - uses: 'google-github-actions/auth@v0' + uses: 'google-github-actions/auth@v1' with: workload_identity_provider: 'projects/123456789/locations/global/workloadIdentityPools/my-pool/providers/my-provider' service_account: 'my-service-account@my-project.iam.gserviceaccount.com' @@ -218,7 +218,7 @@ regardless of the authentication mechanism. job_id: steps: - uses: 'actions/checkout@v3' # Must come first! - - uses: 'google-github-actions/auth@v0' + - uses: 'google-github-actions/auth@v1' ``` - `export_environment_variables`: (Optional) If true, the action will export @@ -290,7 +290,7 @@ jobs: - id: 'auth' name: 'Authenticate to Google Cloud' - uses: 'google-github-actions/auth@v0' + uses: 'google-github-actions/auth@v1' with: workload_identity_provider: 'projects/123456789/locations/global/workloadIdentityPools/my-pool/providers/my-provider' service_account: 'my-service-account@my-project.iam.gserviceaccount.com' @@ -318,7 +318,7 @@ jobs: - id: 'auth' name: 'Authenticate to Google Cloud' - uses: 'google-github-actions/auth@v0' + uses: 'google-github-actions/auth@v1' with: credentials_json: '${{ secrets.GOOGLE_CREDENTIALS }}' ``` @@ -344,7 +344,7 @@ jobs: - id: 'auth' name: 'Authenticate to Google Cloud' - uses: 'google-github-actions/auth@v0' + uses: 'google-github-actions/auth@v1' with: token_format: 'access_token' # Either user Workload Identity Federation or Service Account Keys. See @@ -391,7 +391,7 @@ jobs: # Configure Workload Identity Federation via a credentials file. - id: 'auth' name: 'Authenticate to Google Cloud' - uses: 'google-github-actions/auth@v0' + uses: 'google-github-actions/auth@v1' with: workload_identity_provider: 'projects/123456789/locations/global/workloadIdentityPools/my-pool/providers/my-provider' service_account: 'my-service-account@my-project.iam.gserviceaccount.com' @@ -435,7 +435,7 @@ jobs: # Configure Workload Identity Federation and generate an access token. - id: 'auth' name: 'Authenticate to Google Cloud' - uses: 'google-github-actions/auth@v0' + uses: 'google-github-actions/auth@v1' with: token_format: 'access_token' # <-- workload_identity_provider: 'projects/123456789/locations/global/workloadIdentityPools/my-pool/providers/my-provider' @@ -475,7 +475,7 @@ jobs: # Configure Workload Identity Federation and generate an access token. - id: 'auth' name: 'Authenticate to Google Cloud' - uses: 'google-github-actions/auth@v0' + uses: 'google-github-actions/auth@v1' with: token_format: 'id_token' # <-- workload_identity_provider: 'projects/123456789/locations/global/workloadIdentityPools/my-pool/providers/my-provider' @@ -673,7 +673,7 @@ mappings, see the [GitHub OIDC token documentation](https://docs.github.com/en/a We recommend pinning to the latest available major version: ```yaml -- uses: 'google-github-actions/auth@v0' +- uses: 'google-github-actions/auth@v1' ``` While this action attempts to follow semantic versioning, but we're ultimately @@ -681,7 +681,7 @@ human and sometimes make mistakes. To prevent accidental breaking changes, you can also pin to a specific version: ```yaml -- uses: 'google-github-actions/auth@v0.1.1' +- uses: 'google-github-actions/auth@v1.1.1' ``` However, you will not get automatic security updates or new features without diff --git a/docs/TROUBLESHOOTING.md b/docs/TROUBLESHOOTING.md index 81b19f6c..7e8d0035 100644 --- a/docs/TROUBLESHOOTING.md +++ b/docs/TROUBLESHOOTING.md @@ -7,7 +7,7 @@ Identity, the first step is to ask the `auth` plugin to generate an OAuth access token. Do this by adding `token_format: 'access_token'` to your YAML: ```yaml -- uses: 'google-github-actions/auth@v0' +- uses: 'google-github-actions/auth@v1' with: # ... token_format: 'access_token'