Deployment¶

class github.Deployment.Deployment¶

This class represents Deployments. The reference can be found here https://docs.github.com/en/rest/reference/repos#deployments

id¶

Type:	int

url¶

Type:	string

sha¶

Type:	string

task¶

Type:	string

payload¶

Type:	dict

original_environment¶

Type:	string

environment¶

Type:	string

production_environment¶

Type:	bool

transient_environment¶

Type:	bool

description¶

Type:	string

creator¶

Type:	`github.NamedUser.NamedUser`

created_at¶

Type:	datetime

updated_at¶

Type:	datetime

statuses_url¶

Type:	string

repository_url¶

Type:	string

get_statuses()¶

Calls:	GET /repos/{owner}/deployments/{deployment_id}/statuses
Return type:	`github.PaginatedList.PaginatedList` of `github.DeploymentStatus.DeploymentStatus`

get_status(id_)¶

Calls:	GET /repos/{owner}/deployments/{deployment_id}/statuses/{status_id}
Parameters:	id – int
Return type:	`github.DeploymentStatus.DeploymentStatus`

create_status(state, target_url=NotSet, description=NotSet, environment=NotSet, environment_url=NotSet, auto_inactive=NotSet)¶

Calls:	POST /repos/{owner}/{repo}/deployments/{deployment_id}/statuses
Param:	state: string
Param:	target_url: string
Param:	description: string
Param:	environment: string
Param:	environment_url: string
Param:	auto_inactive: bool
Return type:	`github.DeploymentStatus.DeploymentStatus`