chrnorm/Deployment Action

Creates a GitHub Deployment

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stale
License
None
namedescriptionrequireddefault
repoA custom repository to create the deployment for. Defaults to the repo the action is running in.no
ownerA custom owner to create the deployment for. Defaults to the repo owner the action is running in.no
initial-statusInitial status for the deployment. Can be one of: error, failure, inactive, in_progress, queued, pending, successnopending
tokenGithub repository tokenyes
log-urlLog URL locationno
descriptionDescriptive message about the deploymentno
environmentThe name of the environment for the deploymentnoproduction
environment-urlA URL to access your deploymentno
auto-mergeWhether to attempt to auto-merge the default branch into the branch that the action is running on if set to "true". More details in the GitHub deployments API. Warning - setting this to "true" has caused this action to fail in some casesnofalse
refThe reference for the deploymentno
shaThe commit SHA for the deploymentno
taskThe name of the task for the deployment (e.g., deploy or deploy:migrations). More details in the GitHub deployments API.nodeploy
required-contextsIf provided, must be formatted as a comma-separated string. 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.no
payloadJSON payload with extra information about the deployment. Can be provided as a JSON string.no
transient-environmentSpecifies if the given environment is specific to the deployment and will no longer exist at some point in the future.nofalse
production-environmentSpecifies if the given environment is one that end-users directly interact with. Default: true when environment is production and false otherwise.no
auto-inactiveAdds a new inactive status to all prior non-transient, non-production environment deployments with the same repository and environment name as the created status's deployment. An inactive status is only added to deployments that had a success state. Default: truenotrue
github-base-urlChanges the API base URL for a GitHub Enterprise server.no
namedescription
deployment_idThe ID of the created deployment
deployment_urlThe URL of the created deployment
environment_urlThe environment URL of the deployment