Skip to main content
POST
GitHub Actions Workflow Generator

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
ioWorkflowName
string

Workflow Name

ioStack
enum<string>

Stack

Available options:
node,
python,
go,
rust,
php,
ruby,
java,
dotnet
ioStackVersions
string

Versions

ioPackageManager
enum<string>

Package Manager

Available options:
npm,
yarn,
pnpm
ioPythonManager
enum<string>

Package Manager

Available options:
pip,
poetry,
pipenv
ioJavaDistribution
enum<string>

Java Distribution

Available options:
temurin,
zulu,
adopt,
microsoft,
corretto
ioJavaBuild
enum<string>

Build Tool

Available options:
maven,
gradle
ioTriggerPush
boolean

On push

ioPushBranches
string

Push branches

ioTriggerPR
boolean

On pull_request

ioPRBranches
string

PR target branches

ioTriggerSchedule
boolean

On schedule (cron)

ioCronExpression
string

Cron expression

ioTriggerDispatch
boolean

On workflow_dispatch (manual)

ioMatrixOS
string

Operating Systems

ioStepLint
boolean

Run lint step

ioLintCommand
string

Lint command

ioStepTest
boolean

Run test step

ioTestCommand
string

Test command

ioStepBuild
boolean

Run build step

ioBuildCommand
string

Build command

ioStepDeploy
boolean

Add a deploy job

ioDeployBranch
string

Deploy from branch

ioDeployCommand
string

Deploy command

ioEnableCache
boolean

Cache dependencies

ioEnableConcurrency
boolean

Cancel in-progress runs on the same ref

ioEnvVars
string

Environment Variables

Response

Tool output

tool
string
required
tool_version
string
required

Output-contract version for this tool. Currently "1" for all tools.

outputs
object
required
credits_used
integer
required

Credits this call consumed, after any settlement refund. 0 when metering is disabled.

request_id
string
credits_remaining
integer | null

Credits left in the current monthly allowance, or null when metering is disabled.