Skip to content

Commit f0456d8

Browse files
committed
clean up README a bit
1 parent 0b08366 commit f0456d8

File tree

1 file changed

+15
-9
lines changed

1 file changed

+15
-9
lines changed

README.md

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
# gh-dispatch
44

5-
`gh-dispatch` is a [gh CLI](https://cli.github.com/) extension for triggering [repository_dispatch](https://docs.github.com/en/rest/repos/repos#create-a-repository-dispatch-event) and/or
6-
[workflow_dispatch](https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#workflow_dispatch) events and watching the resulting GitHub Actions workflow run via
7-
a single command.
5+
A [gh CLI](https://cli.github.com/) extension for triggering [repository_dispatch](https://docs.github.com/en/rest/repos/repos#create-a-repository-dispatch-event) and/or
6+
[workflow_dispatch](https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#workflow_dispatch) events and watching the resulting GitHub Actions
7+
workflow run.
88

99
![demo](demo.gif)
1010

@@ -15,18 +15,18 @@ Trigger a repository dispatch event and watch the resulting GitHub Actions run f
1515
```
1616
gh dispatch repository \
1717
--repo "mdb/gh-dispatch" \
18+
--workflow "Hello" \
1819
--event-type "hello" \
19-
--client-payload "{\"name\": \"mike\"}" \
20-
--workflow "Hello"'
20+
--client-payload '{"name": "mike"}'
2121
```
2222

2323
Trigger a workflow dispatch event and watch the resulting GitHub Actions run from your terminal:
2424

2525
```
2626
gh dispatch workflow \
2727
--repo "mdb/gh-dispatch" \
28-
--inputs "{\"name\": \"mike\", "force_fail": "false"}' \
29-
--workflow workflow_dispatch.yaml
28+
--workflow "workflow_dispatch.yaml" \
29+
--inputs '{"name": "mike"}'
3030
```
3131

3232
## Installation
@@ -37,7 +37,7 @@ Install the `gh` CLI [for your platform](https://github.com/cli/cli#installation
3737
brew install gh
3838
```
3939

40-
Install the latest `dispatch` extension from [its pre-compiled releases](https://github.com/mdb/gh-dispatch/releases):
40+
Install the latest `dispatch` extension from [its releases](https://github.com/mdb/gh-dispatch/releases):
4141

4242
```
4343
gh extension install mdb/gh-dispatch
@@ -51,8 +51,14 @@ Build and test `gh-dispatch` locally:
5151
make
5252
```
5353

54-
Install a locally built `gh-dispatch`, thus making it available `gh dispatch`:
54+
Install a locally built `gh-dispatch` for use as `gh dispatch`:
5555

5656
```
5757
make install
5858
```
59+
60+
Run acceptance tests against a local `gh-dispatch` installation:
61+
62+
```
63+
make acc-test
64+
```

0 commit comments

Comments
 (0)