Skip to content

Update README to reference v3 #511

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sethvargo merged 1 commit into from
Aug 28, 2025
Merged

Update README to reference v3 #511

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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"
Expand Down Expand Up @@ -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: '...' # [email protected]
workload_identity_provider: '...' # "projects/123456789/locations/global/workloadIdentityPools/github/providers/my-repo"
Expand Down Expand Up @@ -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
```
Expand Down
16 changes: 8 additions & 8 deletions docs/EXAMPLES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Expand All @@ -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'
Expand All @@ -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: '[email protected]'
Expand All @@ -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 }}'
```
Expand All @@ -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'
Expand Down Expand Up @@ -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'
Expand Down Expand Up @@ -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'
Expand Down Expand Up @@ -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: '[email protected]'
Expand Down
4 changes: 2 additions & 2 deletions docs/TROUBLESHOOTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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_
Expand Down Expand Up @@ -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 }}
Expand Down
Loading