Reference

apex approval

Runs from forks: what is waiting for approval, deciding it, and which ones wait

apex approval [command]

Examples

Runs from forks waiting for somebody to approve them.

apex approval list

Approve one: it runs without secrets, on a runner of its own.

apex approval approve 4812

Hold only first-time contributors’ pull requests from forks, as GitHub does by default.

apex approval policy acme/web first-time

Subcommands

Runs from a fork waiting for an Owner or Admin to approve them

apex approval list [options]

With an API token, needs the permission approvals:read.

Options
Option	Description
`--json`	machine-readable output

Approve one run from a fork — it starts with no secrets and on a runner of its own

apex approval approve [options] <run-id>

With an API token, needs the permission approvals:write.

Arguments
Argument	Description
`<run-id>`	run id (apex approval list prints them)

Options
Option	Description
`--comment <text>`	recorded with the decision

Reject one run from a fork — every job fails and the attempt is closed

apex approval reject [options] <run-id>

With an API token, needs the permission approvals:write.

Arguments
Argument	Description
`<run-id>`	run id (apex approval list prints them)

Options
Option	Description
`--comment <text>`	recorded with the decision

Which pull requests from forks wait for approval on a repository; with a policy, set it (an Owner or Admin)

apex approval policy [options] <repository> [policy]

With an API token, needs the permission administration:write.

Arguments
Argument	Description
`<repository>`	owner/repo
`[policy]`	one of every-fork, external, first-time, first-time-new-to-github

Options
Option	Description
`--json`	machine-readable output