You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Deployments are a request for a specific ref(branch,sha,tag) to be deployed.
24
11
GitHub then dispatches deployment events that external services can listen for
25
12
and act on. This enables developers and organizations to build loosely-coupled
@@ -146,7 +133,7 @@ Users with `repo` or `repo_deployment` scopes can create a deployment for a give
146
133
Name | Type | Description
147
134
-----|------|--------------
148
135
`ref`|`string`| **Required**. The ref to deploy. This can be a branch, tag, or sha.
149
-
`task`|`string`| **Required**. The named task to execute. e.g. `deploy` or `deploy:migrations`. Default: `deploy`
136
+
`task`|`string`| Optional parameter to specify a task to execute, e.g. `deploy` or `deploy:migrations`. Default: `deploy`
150
137
`auto_merge`|`boolean`| Optional parameter to merge the default branch into the requested ref if it is behind the default branch. Default: `true`
151
138
`required_contexts`|`Array`| Optional array of status contexts verified against commit status checks. If this parameter is omitted from the parameters then all unique contexts will be verified before a deployment is created. To bypass checking entirely pass an empty array. Defaults to all unique contexts.
152
139
`payload`|`string` | Optional JSON payload with extra information about the deployment. Default: `""`
0 commit comments