Deployments

Extends \Joomla\Github\AbstractPackage

GitHub API Deployments class for the Joomla Framework.

documentation

https://developer.github.com/v3/repos/deployments

since

1.4.0

Methods

__construct

Constructor.

__construct(\Joomla\Registry\Registry $options = null, \Joomla\Http\Http $client = null) 
inherited
since

1.0

Arguments

$options

\Joomla\Registry\RegistryGitHub options object.

$client

\Joomla\Http\HttpThe HTTP client object.

__get

Magic method to lazily create API objects

__get(string $name) : \Joomla\Github\AbstractPackage
inherited
since

1.0

throws

\InvalidArgumentException

Arguments

$name

stringName of property to retrieve

Response

\Joomla\Github\AbstractPackageGitHub API package object.

create

Create a Deployment.

create(string $owner, string $repo, string $ref, string $task = '', boolean $autoMerge = true, array|null $requiredContexts = null, string $payload = '', string $environment = '', string $description = '') : object
since

1.4.0

throws

\RuntimeException

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

booleanOptional parameter to merge the default branch into the requested ref if behind the default branch.

$requiredContexts

array|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(string $owner, string $repo, integer $id, string $state, string $targetUrl = '', string $description = '') : object
since

1.4.0

throws

\InvalidArgumentException

Arguments

$owner

stringThe name of the owner of the GitHub repository.

$repo

stringThe name of the GitHub repository.

$id

integerThe 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(string $path, integer $page, integer $limit) : string
inherited
since

1.0

note

As of 2.0 this method will return a Joomla\Uri\Uri object

Arguments

$path

stringURL to inflect

$page

integerPage to request

$limit

integerNumber of results to return per page

Response

stringThe request URL.

getDeploymentStatuses

List Deployment Statuses.

getDeploymentStatuses(string $owner, string $repo, integer $id, integer $page, integer $limit) : object
since

1.4.0

Arguments

$owner

stringThe name of the owner of the GitHub repository.

$repo

stringThe name of the GitHub repository.

$id

integerThe Deployment ID to list the statuses from.

$page

integerThe page number from which to get items.

$limit

integerThe number of items on a page.

Response

object

getList

List Deployments.

getList(string $owner, string $repo, string $sha = '', string $ref = '', string $task = '', string $environment = '', integer $page, integer $limit) : object
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

integerThe page number from which to get items.

$limit

integerThe number of items on a page.

Response

object

processResponse

Process the response and decode it.

processResponse(\Joomla\Http\Response $response, integer $expectedCode = 200) : mixed
inherited
since

1.0

throws

\Joomla\Http\Exception\UnexpectedResponseException

Arguments

$response

\Joomla\Http\ResponseThe response.

$expectedCode

integerThe expected "good" code.

Response

mixed

Properties

options

Options for the GitHub object.

inherited
since

1.0

Type(s)

\Joomla\Registry\Registry

client

The HTTP client object to use in sending HTTP requests.

inherited
since

1.0

Type(s)

\Joomla\Github\Http

package

The package the object resides in

inherited
since

1.0

Type(s)

string

hookEvents

Array containing the allowed hook events

inherited
since

1.5.2

link

https://developer.github.com/webhooks/#events

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