Skip to content

Commit dac7338

Browse files
committed
docs: add mention of await-remote-run
1 parent 5022e2e commit dac7338

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ Dispatch an action to a foreign repository and output the newly created run ID.
66

77
This Action exists as a workaround for the issue where dispatching an action to foreign repository does not return any kind of identifier.
88

9+
The returned run ID can be used to await the completion of the remote run using [`await-remote-run`](https://github.com/Codex-/await-remote-run).
10+
911
## Usage
1012

1113
Ensure you have configured your remote action correctly, see below for an example.
@@ -35,6 +37,14 @@ steps:
3537
run: |
3638
echo ${{steps.return_dispatch.outputs.run_id}}
3739
echo ${{steps.return_dispatch.outputs.run_url}}
40+
41+
- name: Await Run ID ${{ steps.return_dispatch.outputs.run_id }}
42+
uses: Codex-/await-remote-run@v1
43+
with:
44+
token: ${{ github.token }}
45+
repo: repository-name
46+
owner: repository-owner
47+
run_id: ${{ steps.return_dispatch.outputs.run_id }}
3848
```
3949
4050
### Receiving Repository Action

0 commit comments

Comments
 (0)