actions/auth
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Switch to auth@v1 (#238)

Browse Source 
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.
This commit is contained in:
Seth Vargo 2022-11-08 12:00:36 -05:00 committed by GitHub
parent 44ae44c257
commit 9cf496b575
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -68,7 +68,7 @@ jobs:
- id: 'auth' - id: 'auth'
name: 'Authenticate to Google Cloud' name: 'Authenticate to Google Cloud'
uses: 'google-github-actions/auth@v0' uses: 'google-github-actions/auth@v1'
with: with:
workload_identity_provider: 'projects/123456789/locations/global/workloadIdentityPools/my-pool/providers/my-provider' workload_identity_provider: 'projects/123456789/locations/global/workloadIdentityPools/my-pool/providers/my-provider'
service_account: 'my-service-account@my-project.iam.gserviceaccount.com' service_account: 'my-service-account@my-project.iam.gserviceaccount.com'
@ -218,7 +218,7 @@ regardless of the authentication mechanism.
job_id: job_id:
steps: steps:
- uses: 'actions/checkout@v3' # Must come first! - 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 - `export_environment_variables`: (Optional) If true, the action will export
@ -290,7 +290,7 @@ jobs:
- id: 'auth' - id: 'auth'
name: 'Authenticate to Google Cloud' name: 'Authenticate to Google Cloud'
uses: 'google-github-actions/auth@v0' uses: 'google-github-actions/auth@v1'
with: with:
workload_identity_provider: 'projects/123456789/locations/global/workloadIdentityPools/my-pool/providers/my-provider' workload_identity_provider: 'projects/123456789/locations/global/workloadIdentityPools/my-pool/providers/my-provider'
service_account: 'my-service-account@my-project.iam.gserviceaccount.com' service_account: 'my-service-account@my-project.iam.gserviceaccount.com'
@ -318,7 +318,7 @@ jobs:
- id: 'auth' - id: 'auth'
name: 'Authenticate to Google Cloud' name: 'Authenticate to Google Cloud'
uses: 'google-github-actions/auth@v0' uses: 'google-github-actions/auth@v1'
with: with:
credentials_json: '${{ secrets.GOOGLE_CREDENTIALS }}' credentials_json: '${{ secrets.GOOGLE_CREDENTIALS }}'
``` ```
@ -344,7 +344,7 @@ jobs:
- id: 'auth' - id: 'auth'
name: 'Authenticate to Google Cloud' name: 'Authenticate to Google Cloud'
uses: 'google-github-actions/auth@v0' uses: 'google-github-actions/auth@v1'
with: with:
token_format: 'access_token' token_format: 'access_token'
# Either user Workload Identity Federation or Service Account Keys. See # Either user Workload Identity Federation or Service Account Keys. See
@ -391,7 +391,7 @@ jobs:
# Configure Workload Identity Federation via a credentials file. # Configure Workload Identity Federation via a credentials file.
- id: 'auth' - id: 'auth'
name: 'Authenticate to Google Cloud' name: 'Authenticate to Google Cloud'
uses: 'google-github-actions/auth@v0' uses: 'google-github-actions/auth@v1'
with: with:
workload_identity_provider: 'projects/123456789/locations/global/workloadIdentityPools/my-pool/providers/my-provider' workload_identity_provider: 'projects/123456789/locations/global/workloadIdentityPools/my-pool/providers/my-provider'
service_account: 'my-service-account@my-project.iam.gserviceaccount.com' service_account: 'my-service-account@my-project.iam.gserviceaccount.com'
@ -435,7 +435,7 @@ jobs:
# Configure Workload Identity Federation and generate an access token. # Configure Workload Identity Federation and generate an access token.
- id: 'auth' - id: 'auth'
name: 'Authenticate to Google Cloud' name: 'Authenticate to Google Cloud'
uses: 'google-github-actions/auth@v0' uses: 'google-github-actions/auth@v1'
with: with:
token_format: 'access_token' # <-- token_format: 'access_token' # <--
workload_identity_provider: 'projects/123456789/locations/global/workloadIdentityPools/my-pool/providers/my-provider' 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. # Configure Workload Identity Federation and generate an access token.
- id: 'auth' - id: 'auth'
name: 'Authenticate to Google Cloud' name: 'Authenticate to Google Cloud'
uses: 'google-github-actions/auth@v0' uses: 'google-github-actions/auth@v1'
with: with:
token_format: 'id_token' # <-- token_format: 'id_token' # <--
workload_identity_provider: 'projects/123456789/locations/global/workloadIdentityPools/my-pool/providers/my-provider' 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: We recommend pinning to the latest available major version:
```yaml ```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 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: can also pin to a specific version:
```yaml ```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 However, you will not get automatic security updates or new features without

2
docs/TROUBLESHOOTING.md
View File

@ -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: token. Do this by adding `token_format: 'access_token'` to your YAML:
```yaml ```yaml
- uses: 'google-github-actions/auth@v0' - uses: 'google-github-actions/auth@v1'
with: with:
# ... # ...
token_format: 'access_token' token_format: 'access_token'