Environment

class github.Environment.Environment

This class represents Environment.

The reference can be found here https://docs.github.com/en/rest/reference/deployments#environments

The OpenAPI schema can be found at

/components/schemas/environment

A CompletableGithubObject can be partially initialised (completed=False). Accessing attributes that are not initialized will then trigger a request to complete all attributes.

A partially initialized CompletableGithubObject (completed=False) can be completed via complete(). This requires the url to be given via parameter url or attributes.

With a requester where Requester.is_lazy == True, this CompletableGithubObjects is partially initialized. This requires the url to be given via parameter url or attributes. Any CompletableGithubObject created from this lazy object will be lazy itself if created with parameter url or attributes.

Parameters:

requester – requester
headers – response headers
attributes – attributes to initialize
completed – do not update non-initialized attributes when True
url – url of this instance, overrides attributes[‘url’]
accept – use this accept header when completing this instance

property environments_url: str

Type:: string

property url: str

Type:: string

get_public_key() → PublicKey

Calls:: GET /repos/{owner}/{repo}/environments/{environment_name}/secrets/public-key
Return type:: PublicKey

create_secret(secret_name: str, unencrypted_value: str) → Secret

Calls:: PUT /repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}

get_secrets() → PaginatedList[Secret]

Gets all repository secrets.

Calls:: GET /repos/{owner}/{repo}/environments/{environment_name}/secrets

get_secret(secret_name: str) → Secret

Calls:: GET /repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}

create_variable(variable_name: str, value: str) → Variable

Calls:: POST /repos/{owner}/{repo}/environments/{environment_name}/variables/{name}

get_variables() → PaginatedList[Variable]: Gets all repository variables :rtype: PaginatedList of Variable

get_variable(variable_name: str) → Variable

Calls:: GET /repos/{owner}/{repo}/environments/{environment_name}/variables/{name}
Parameters:: variable_name – string
Return type:: Variable

delete_secret(secret_name: str) → bool

Calls:: DELETE /repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}
Parameters:: secret_name – string
Return type:: bool

delete_variable(variable_name: str) → bool

Calls:: DELETE /repos/{owner}/{repo}/environments/{environment_name}/variables/{name}
Parameters:: variable_name – string
Return type:: bool