Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/srz-zumix/gh-act
gh-act generates and configures event.json for nektos/act
https://github.com/srz-zumix/gh-act
gh-extension
Last synced: about 1 month ago
JSON representation
gh-act generates and configures event.json for nektos/act
- Host: GitHub
- URL: https://github.com/srz-zumix/gh-act
- Owner: srz-zumix
- License: mit
- Created: 2022-08-05T13:29:38.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-07T04:02:05.000Z (5 months ago)
- Last Synced: 2024-05-07T11:38:26.505Z (5 months ago)
- Topics: gh-extension
- Language: Shell
- Homepage:
- Size: 170 KB
- Stars: 10
- Watchers: 3
- Forks: 0
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# gh-act
gh-act generates and configures event.json for [nektos/act][]
## Installation
```sh
gh extension install srz-zumix/gh-act
```
## Usage
```sh
gh act pull_request
```
Create event.json in a temporary file, add it to the options of act and execute
```sh
gh act pull_request -e pull_request.json
```
gh-act does nothing if exist pull_request.json file.
If pull_request.json is not exist, gh-act will generate it in the specified file.
Please check [test workflow][](Diff step) for the difference between the generated event.json and the actual event
## Features
### Events
Supported Events
| Event | Configurable environment variables (prefix: GHACT_) | default action |
|:-----------------------|:-----------------------------------|-----------------|
| branch_protection_rule | ACTION | created |
| check_run | ACTION,BRANCH | completed |
| check_suite | ACTION,BRANCH | completed |
| create | BRANCH | |
| delete | BRANCH | |
| discussion | ACTION,DISCUSSION_NUMBER | created |
| discussion_comment | ACTION,DISCUSSION_NUMBER | created |
| gollum | ACTION | created |
| issue_comment | ACTION,ISSUE_NUMBER | created |
| issues | ACTION,ISSUE_NUMBER | opened |
| label | ACTION | created |
| milestone | ACTION,MILESTONE_NUMBER | created |
| page_build | | |
| public | | |
| pull_request | ACTION,BRANCH,PULL_REQUEST_SPEC,PULL_REQUEST_NUMBER | synchronize |
| pull_request_review | ACTION,BRANCH,PULL_REQUEST_SPEC,PULL_REQUEST_NUMBER | submiited |
| pull_request_target | ACTION,BRANCH,PULL_REQUEST_SPEC,PULL_REQUEST_NUMBER | synchronize |
| push | BRANCH | |
| registry_package | ACTION,BRANCH,PACKAGE_TYPE,PACKAGE_TYPE | published |
| release | ACTION,RELEASE_NAME | released |
| repository_dispatch | ACTION,CLIENT_PAYLOAD | (empty) |
| schedule | SCHEDULE_CRON | |
| status | BRANCH | |
| watch | ACTION | started |
| workflow_dispatch | INPUTS | |
### Environment Variables
| name | description | default |
|:---------------------------|:---------------------------------------------------------------------------------------|:-----------------------|
| GHACT_ACTION | specify action name | (per [events](#Events))|
| GHACT_AUTO_GITHUB_TOKEN | flag to automatically set the GITHUB_TOKEN secret | true |
| GHACT_BRANCH | specify branch name | current branch |
| GHACT_CLIENT_PAYLOAD | repository_dispatch client_payload json string | null |
| GHACT_CREATE_EVENT_JSON | if you specify false, gh act will not generate event json | true |
| GHACT_DISCUSSION_NUMBER | specify issue number ({github_host}/{owner}/{repo}/discussions/{__number__}) | null |
| GHACT_INPUTS | workflow_dispatch inputs json string | null |
| GHACT_ISSUE_NUMBER | specify issue number ({github_host}/{owner}/{repo}/issues/{__number__}) | last issue number |
| GHACT_MILESTONE_NUMBER | specify milestone number ({github_host}/{owner}/{repo}/milestone/{__number__}) | last milestone number |
| GHACT_PACKAGE_NAME | specify package name | first package name |
| GHACT_PACKAGE_TYPE | specify package type ([supported package_type][]) | container |
| GHACT_PULL_REQUEST_NUMBER | specify pull request number ({github_host}/{owner}/{repo}/pull/{__number__}) | gh pr view --json number --jq .number |
| GHACT_PULL_REQUEST_SPEC | specify gh pr view __[\ \| \ \| \]__ | |
| GHACT_RELEASE_NAME | specify release name | gh release list -L 1 --exclude-drafts |
| GHACT_SCHEDULE_CRON | specify [cron string][] | 0 0 * * * |
### GITHUB_TOKEN
gh-act passes following token as GITHUB_TOKEN secret to act.
* GITHUB_TOKEN
* GH_TOKEN / GH_ENTERPRISE_TOKEN
* gh auth token
* \/hosts.yml token
Set GHACT_AUTO_GITHUB_TOKEN=false to disable this feature.
> GHACT_AUTO_GITHUB_TOKEN=false gh act ...
[act]:https://github.com/nektos/act
[nektos/act]:https://github.com/nektos/act
[test workflow]:https://github.com/srz-zumix/gh-act/actions/workflows/main.yml
[cron string]:https://pubs.opengroup.org/onlinepubs/9699919799/utilities/crontab.html#tag_20_25_07
[supported package_type]:https://docs.github.com/ja/rest/packages#list-packages-for-an-organization