paperboxai/Create a GitHub deployment

Create a new deployment in your repo.

Trust Signals

name	description	required	default
ref	The ref to deploy. This can be a branch, tag, or SHA.	—	""
task	Specifies a task to execute. Default: "deploy"	—	deploy
auto_merge	Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch. Default: true	—	true
required_contexts	The status contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts.	—	*
payload	JSON payload with extra information about the deployment. Default: ""	—	""
environment	Name for the target deployment environment (e.g., production, staging, qa). Default: production	—	production
description	Short description of the deployment. Default: ""	—	""
production_environment	Specifies if the given environment is one that end-users directly interact with. Default: true when environment is production and false otherwise.	—	""
transient_environment	Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: false	—	false

name	description
deployment_id	The identifier of the newly created deployment.
deployment_url	The API url of the newly created deployment.
statuses_url	The API url of the deployment statuses.