Skip to content

Commit f9938af

Browse files
committed
Update checks README for local dev
1 parent 5d89e8e commit f9938af

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

cmd/checks/README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,33 @@ Usage of bin/checks:
2727

2828
Capture actual webhook payloads for `pull_request`, `check_suite`, `check_run` events by running `cat /github/workflow/event.json` on GitHub Actions.
2929

30+
Install this workflow onto your test repository:
31+
32+
https://github.com/variantdev/variant-github-actions-demo/blob/master/.github/workflows/dump-event.yml
33+
34+
Open a PR against the repo:
35+
36+
```
37+
git checkout -b test
38+
git commit --allow-empty
39+
git push
40+
hub pull-request
41+
```
42+
43+
Browse to the Actions tab in your repo:
44+
45+
```
46+
open https://github.com/USER/REPO/actions
47+
```
48+
49+
Nagivate to the workflow run that corresponds to the pull request and browse `View raw logs` in the popup menu.
50+
51+
Copy the dump of the event.json and save it as a json file:
52+
53+
```
54+
$ pbpaste | awk '{$1=""; print $0;}' > pull_request_event.json
55+
```
56+
3057
Then build and run `checks` against json files containing captured events:
3158

3259
```

0 commit comments

Comments
 (0)