Skip to content

Commit 83354ca

Browse files
authored
Update TROUBLESHOOTING.md (#457)
Fix a bunch of issues since GitHub apparently dropped support for special callouts. Refs #455 Signed-off-by: Seth Vargo <[email protected]>
1 parent 6fc4af4 commit 83354ca

File tree

1 file changed

+8
-16
lines changed

1 file changed

+8
-16
lines changed

docs/TROUBLESHOOTING.md

+8-16
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,7 @@
66
see exactly which step is failing. Ensure you are using the latest version
77
of the GitHub Action.
88

9-
> [!CAUTION]
10-
>
11-
> Enabling debug logging increases the chances of a secret
9+
> **⚠️ WARNING!** Enabling debug logging increases the chances of a secret
1210
> being accidentally logged. While GitHub Actions will scrub secrets,
1311
> please take extra caution when sharing these debug logs in publicly
1412
> accessible places like GitHub issues.
@@ -46,7 +44,7 @@
4644

4745
```diff
4846
- projects/my-project/locations/global/workloadIdentityPools/my-pool/providers/my-provider
49-
+ projects/1234567890/locations/global/workloadIdentityPools/my-pool/providers/
47+
+ projects/1234567890/locations/global/workloadIdentityPools/my-pool/providers/my-provider
5048
```
5149

5250
1. Ensure that you have the correct `permissions:` for the job in your
@@ -64,11 +62,9 @@
6462
GitHub OIDC token. You cannot grant permissions on an attribute unless you
6563
map that value from the incoming GitHub OIDC token.
6664

67-
> [!TIP]
68-
>
69-
> Use the [GitHub Actions OIDC Debugger][oidc-debugger] to print the list of
70-
> token claims and compare them to your Attribute Mappings and Attribute
71-
> Conditions.
65+
> **ℹ️ TIP!** Use the [GitHub Actions OIDC Debugger][oidc-debugger] to print
66+
> the list of token claims and compare them to your Attribute Mappings and
67+
> Attribute Conditions.
7268

7369
1. Ensure you have the correct character casing and capitalization. GitHub does
7470
not distinguish between "foobar" and "FooBar", but Google Cloud does. Ensure
@@ -89,10 +85,8 @@
8985
1. Enable `Admin Read`, `Data Read`, and `Data Write` [Audit Logging][cal] for
9086
Identity and Access Management (IAM) in your Google Cloud project.
9187

92-
> [!WARNING]
93-
>
94-
> This will increase log volume which may increase costs. You can disable
95-
> this audit logging after you have debugged the issue.
88+
> **⚠️ WARNING!** This will increase log volume which may increase costs.
89+
> You can disable this audit logging after you have debugged the issue.
9690

9791
Try to authenticate again, and then explore the logs for your Workload
9892
Identity Provider and Workload Identity Pool. Sometimes these error messages
@@ -238,9 +232,7 @@ cat credentials.json | jq -r tostring
238232

239233
## Organizational Policy Constraints
240234

241-
> [!NOTE]
242-
>
243-
> Your Google Cloud organization administrator controls these
235+
> **ℹ️ NOTE!** Your Google Cloud organization administrator controls these
244236
> policies. You must work with your internal IT department to resolve OrgPolicy
245237
> violations and constraints.
246238

0 commit comments

Comments
 (0)