Deployments
Extends AbstractPackageGitHub API Deployments class for the Joomla Framework.
| documentation |
https://developer.github.com/v3/repos/deployments |
|---|---|
| since |
1.4.0 |
| package |
Joomla Framework |
Methods
__construct
Constructor.
__construct(\Joomla\Registry\Registry options = null, \Joomla\Http\Http client = null) :
__get
Magic method to lazily create API objects
__get( name) : \Joomla\Github\AbstractPackage
| since |
1.0 |
|---|---|
| throws |
|
Arguments
- name
stringName of property to retrieve
Response
AbstractPackageGitHub API package object.
create
Create a Deployment.
create( owner, repo, ref, task = '', autoMerge = true, array|null requiredContexts = null, payload = '', environment = '', description = '') :
| since |
1.4.0 |
|---|---|
| throws |
|
Arguments
- owner
stringThe name of the owner of the GitHub repository.- repo
stringThe name of the GitHub repository.- ref
stringThe ref to deploy. This can be a branch, tag, or SHA.- task
stringOptional parameter to specify a task to execute.- autoMerge
boolOptional parameter to merge the default branch into the requested ref if it is behind the default branch.- requiredContexts
array<string|int, mixed>|nullOptional 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.- payload
stringOptional JSON payload with extra information about the deployment.- environment
stringOptional name for the target deployment environment.- description
stringOptional short description.
Response
object
createStatus
Create a Deployment Status.
createStatus( owner, repo, id, state, targetUrl = '', description = '') :
| since |
1.4.0 |
|---|---|
| throws |
|
Arguments
- owner
stringThe name of the owner of the GitHub repository.- repo
stringThe name of the GitHub repository.- id
intThe Deployment ID to list the statuses from.- state
stringThe state of the status.- targetUrl
stringThe target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment.- description
stringA short description of the status. Maximum length of 140 characters.
Response
object
fetchUrl
Method to build and return a full request URL for the request. This method will add appropriate pagination details if necessary and also prepend the API url to have a complete URL for the request.
fetchUrl( path, page, limit) : \Joomla\Uri\Uri
| since |
1.0 |
|---|
Arguments
- path
stringURL to inflect- page
intPage to request- limit
intNumber of results to return per page
Response
getDeploymentStatuses
List Deployment Statuses.
getDeploymentStatuses( owner, repo, id, page, limit) :
| since |
1.4.0 |
|---|
Arguments
- owner
stringThe name of the owner of the GitHub repository.- repo
stringThe name of the GitHub repository.- id
intThe Deployment ID to list the statuses from.- page
intThe page number from which to get items.- limit
intThe number of items on a page.
Response
object
getList
List Deployments.
getList( owner, repo, sha = '', ref = '', task = '', environment = '', page, limit) :
| since |
1.4.0 |
|---|
Arguments
- owner
stringThe name of the owner of the GitHub repository.- repo
stringThe name of the GitHub repository.- sha
stringThe SHA that was recorded at creation time.- ref
stringThe name of the ref. This can be a branch, tag, or SHA.- task
stringThe name of the task for the deployment.- environment
stringThe name of the environment that was deployed to.- page
intThe page number from which to get items.- limit
intThe number of items on a page.
Response
object
processResponse
Process the response and decode it.
processResponse(\Joomla\Http\Response response, expectedCode = 200) :
| since |
1.0 |
|---|---|
| throws |
Arguments
- response
ResponseThe response.- expectedCode
intThe expected "good" code.
Response
mixed
Properties
package
The package the object resides in
| since |
1.0 |
|---|
Type(s)
string
hookEvents
Array containing the allowed hook events
| since |
1.5.2 |
|---|---|
| link | |
| note |
From 1.4.0 to 1.5.1 this was named $events, it was renamed due to naming conflicts with package subclasses |
Type(s)
array<string|int, mixed>