gh-act

gh-act generates and configures event.json for nektos/act

Installation

gh extension install srz-zumix/gh-act

Usage

gh act pull_request

Create event.json in a temporary file, add it to the options of act and execute

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)
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 [<number> | <url> | <branch>]
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
• <gh-config-dir>/hosts.yml token

Set GHACT_AUTO_GITHUB_TOKEN=false to disable this feature.

GHACT_AUTO_GITHUB_TOKEN=false gh act ...