Skip to content

Commit

Permalink
Switch to auth@v1 (#238)
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
sethvargo committed Nov 8, 2022
1 parent 44ae44c commit 9cf496b
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 11 deletions.
20 changes: 10 additions & 10 deletions README.md
Expand Up @@ -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'
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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'
Expand Down Expand Up @@ -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 }}'
```
Expand All @@ -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
Expand Down Expand Up @@ -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'
Expand Down Expand Up @@ -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'
Expand Down Expand Up @@ -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'
Expand Down Expand Up @@ -673,15 +673,15 @@ 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
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
Expand Down
2 changes: 1 addition & 1 deletion docs/TROUBLESHOOTING.md
Expand Up @@ -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'
Expand Down

0 comments on commit 9cf496b

Please sign in to comment.