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

Updated troubleshooting to add permissions example (#262)

Browse Source 
<!--
Thank you for proposing a pull request! Please note that SOME TESTS WILL
LIKELY FAIL due to how GitHub exposes secrets in Pull Requests from
forks.
Someone from the team will review your Pull Request and respond.

Please describe your change and any implementation details below.
-->

Added another case that can cause `auth` to fail, helpful to users on
day one of using the tool and trying to understand what's happening.

Fixes
https://github.com/google-github-actions/auth/issues/260#issuecomment-1419662751
This commit is contained in:
Broc Seib 2023-02-21 09:06:08 -05:00 committed by GitHub
parent 1475a55569
commit 483e21d723
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
docs/TROUBLESHOOTING.md
View File

@ -35,7 +35,7 @@ further debug:
libraries. Please note that we do not have control over actions outside of
`google-github-actions`.
If your workflow _fails_ after adding the the step to generate an access token,
If your workflow _fails_ after adding the step to generate an access token,
it likely means there is a misconfiguration with Workload Identity. Here are
some common sources of errors:
@ -55,6 +55,15 @@ some common sources of errors:
**number**. Workload Identity Federation does not accept Google Cloud
Project IDs.
1. Ensure that you have the correct `permissions:` for the job in your workflow, per
the [usage](../README.md#usage) docs, i.e.
```yaml
permissions:
contents: 'read'
id-token: 'write'
```
1. Ensure you have created an **Attribute Mapping** for any **Attribute
Conditions** or **Service Account Impersonation** principals. You cannot
create an Attribute Condition unless you map that value from the incoming