mirror of
https://github.com/peter-evans/repository-dispatch.git
synced 2026-06-11 11:21:25 +00:00
docs: update readme
Just some minor changes to keep things consistent with the style of my other actions repos
This commit is contained in:
30
README.md
30
README.md
@@ -10,31 +10,27 @@ A GitHub action to create a repository dispatch event.
|
|||||||
|
|
||||||
In the caller workflow file:
|
In the caller workflow file:
|
||||||
|
|
||||||
```diff
|
```yml
|
||||||
jobs:
|
jobs:
|
||||||
your_job_name:
|
Dispatch:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
+ permissions:
|
permissions:
|
||||||
+ contents: write
|
contents: write
|
||||||
steps:
|
steps:
|
||||||
…
|
- name: Repository Dispatch
|
||||||
+ - name: Repository Dispatch
|
uses: peter-evans/repository-dispatch@v3
|
||||||
+ uses: peter-evans/repository-dispatch@v3
|
with:
|
||||||
+ with:
|
event-type: my-event
|
||||||
+ event-type: my-event
|
|
||||||
```
|
```
|
||||||
|
|
||||||
In the callee workflow file:
|
In the callee workflow file:
|
||||||
|
|
||||||
```diff
|
```yml
|
||||||
name: YourWorkflow
|
name: MyWorkflow
|
||||||
|
|
||||||
+on:
|
on:
|
||||||
+ repository_dispatch:
|
repository_dispatch:
|
||||||
+ types: [my-event]
|
types: [my-event]
|
||||||
|
|
||||||
jobs:
|
|
||||||
…
|
|
||||||
```
|
```
|
||||||
|
|
||||||
### Dispatching an event to a remote repository
|
### Dispatching an event to a remote repository
|
||||||
|
|||||||
Reference in New Issue
Block a user