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
Copy file name to clipboardExpand all lines: content/v3/repos/deployments.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ title: Deployments
6
6
7
7
{:toc}
8
8
9
-
Deployments are a request for a specific ref(branch,sha,tag) to be deployed.
9
+
Deployments are a request for a specific ref(branch,SHA,tag) to be deployed.
10
10
GitHub then dispatches deployment events that external services can listen for
11
11
and act on. This enables developers and organizations to build loosely-coupled
12
12
tooling around deployments, without having to worry about implementation
@@ -78,8 +78,8 @@ Simple filtering of deployments is available via query parameters:
78
78
79
79
Name | Type | Description
80
80
-----|------|--------------
81
-
`sha`|`string` | The short or long sha that was recorded at creation time. Default: `none`
82
-
`ref`|`string` | The name of the ref. This can be a branch, tag, or sha. Default: `none`
81
+
`sha`|`string` | The SHA that was recorded at creation time. Default: `none`
82
+
`ref`|`string` | The name of the ref. This can be a branch, tag, or SHA. Default: `none`
83
83
`task`|`string` | The name of the task for the deployment. e.g. `deploy` or `deploy:migrations`. Default: `none`
84
84
`environment`|`string` | The name of the environment that was deployed to. e.g. `staging` or `production`. Default: `none`
85
85
@@ -92,7 +92,7 @@ Name | Type | Description
92
92
93
93
Deployments offer a few configurable parameters with sane defaults.
94
94
95
-
The `ref` parameter can be any named branch, tag, or sha. At GitHub we often
95
+
The `ref` parameter can be any named branch, tag, or SHA. At GitHub we often
96
96
deploy branches and verify them before we merge a pull request.
97
97
98
98
The `environment` parameter allows deployments to be issued to different
@@ -131,7 +131,7 @@ Users with `repo` or `repo_deployment` scopes can create a deployment for a give
131
131
132
132
Name | Type | Description
133
133
-----|------|--------------
134
-
`ref`|`string`| **Required**. The ref to deploy. This can be a branch, tag, or sha.
134
+
`ref`|`string`| **Required**. The ref to deploy. This can be a branch, tag, or SHA.
135
135
`task`|`string`| Optional parameter to specify a task to execute, e.g. `deploy` or `deploy:migrations`. Default: `deploy`
136
136
`auto_merge`|`boolean`| Optional parameter to merge the default branch into the requested ref if it is behind the default branch. Default: `true`
137
137
`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.
0 commit comments