yume/act
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add event documentation (#137)

Browse source
This commit is contained in:
Jacob Turner 2020-03-06 18:05:36 -07:00 committed by GitHub
parent ca648a37c8
commit 643f8d08b7
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 21 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
README.md
View file

@ -99,6 +99,27 @@ Additionally, act support loading environment variables from a `.env` file. The
act --env-file my.env
```
# Events
Every [Github event](https://developer.github.com/v3/activity/events/types) is accompanied with a payload. You can provide these events in JSON format with the `--eventpath` to simulate specific Github events kicking off an action. For example:
``` pull-request.json
{
"pull_request": {
"head": {
"ref": "sample-head-ref"
},
"base": {
"ref": "sample-base-ref"
}
}
}
```
```
act -e pull-request.json
```
Act will properly provide `github.head_ref` and `github.base_ref` to the action as expected.
# Support
Need help? Ask on [Gitter](https://gitter.im/nektos/act)!