Skip to content

Commit aa19867

Browse files
committed
update docs
1 parent aa17d83 commit aa19867

File tree

1 file changed

+44
-2
lines changed

1 file changed

+44
-2
lines changed

README.md

Lines changed: 44 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,14 @@ This action requests a JWT and prints the claims included within the JWT receive
44

55
## How to use this Action
66

7-
Here's an example of how to use that action:
7+
Here's an example of how to use this action:
88

99
```yaml
1010

11-
on: [pull_request]
11+
name: Test Debugger Action
12+
on:
13+
pull_request:
14+
workflow_dispatch:
1215

1316
jobs:
1417
oidc_debug_test:
@@ -23,3 +26,42 @@ jobs:
2326
with:
2427
audience: '${{ github.server_url }}/${{ github.repository_owner }}'
2528
```
29+
30+
The resulting output in your Actions log will look something like this:
31+
32+
```json
33+
{
34+
"actor": "GrantBirki",
35+
"actor_id": "23362539",
36+
"aud": "https://github.com/github",
37+
"base_ref": "main",
38+
"enterprise": "github",
39+
"enterprise_id": "11468",
40+
"event_name": "pull_request",
41+
"exp": 1751581975,
42+
"head_ref": "release-setup",
43+
"iat": 1751560375,
44+
"iss": "https://token.actions.githubusercontent.com",
45+
"job_workflow_ref": "github/actions-oidc-debugger/.github/workflows/action-test.yml@refs/pull/27/merge",
46+
"job_workflow_sha": "7f93a73b8273af5d35fcd70661704c1cadc57054",
47+
"jti": "4a576b35-ff09-41c5-af2c-ca62dd89b76a",
48+
"nbf": 1751560075,
49+
"ref": "refs/pull/27/merge",
50+
"ref_protected": "false",
51+
"ref_type": "branch",
52+
"repository": "github/actions-oidc-debugger",
53+
"repository_id": "487920697",
54+
"repository_owner": "github",
55+
"repository_owner_id": "9919",
56+
"repository_visibility": "public",
57+
"run_attempt": "1",
58+
"run_id": "16055869479",
59+
"run_number": "33",
60+
"runner_environment": "github-hosted",
61+
"sha": "7f93a73b8273af5d35fcd70661704c1cadc57054",
62+
"sub": "repo:github/actions-oidc-debugger:pull_request",
63+
"workflow": "Test Debugger Action",
64+
"workflow_ref": "github/actions-oidc-debugger/.github/workflows/action-test.yml@refs/pull/27/merge",
65+
"workflow_sha": "7f93a73b8273af5d35fcd70661704c1cadc57054"
66+
}
67+
```

0 commit comments

Comments
 (0)