Environment

class github.Environment.Environment

This class represents Environment.

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

property environments_url
Type

string

property url
Type

string

get_public_key() → github.PublicKey.PublicKey
Calls

GET /repositories/{repository_id}/environments/{environment_name}/secrets/public-key

Return type

PublicKey

create_secret(secret_name: str, unencrypted_value: str) → github.Secret.Secret
Calls

PUT /repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}

get_secrets() → github.PaginatedList.PaginatedList[github.Secret.Secret][github.Secret.Secret]

Gets all repository secrets.

get_secret(secret_name: str) → github.Secret.Secret
Calls

‘GET /repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name} <https://docs.github.com/en/rest/secrets#get-an-organization-secret>`_

create_variable(variable_name: str, value: str) → github.Variable.Variable
Calls

POST /repositories/{repository_id}/environments/{environment_name}/variables/{variable_name}

get_variables() → github.PaginatedList.PaginatedList[github.Variable.Variable][github.Variable.Variable]

Gets all repository variables :rtype: PaginatedList of Variable

get_variable(variable_name: str) → github.Variable.Variable
Calls

‘GET /orgs/{org}/variables/{variable_name} <https://docs.github.com/en/rest/variables#get-an-organization-variable>`_

Parameters

variable_name – string

Return type

Variable

delete_secret(secret_name: str) → bool
Calls

DELETE /repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}

Parameters

secret_name – string

Return type

bool

delete_variable(variable_name: str) → bool
Calls

DELETE /repositories/{repository_id}/environments/{environment_name}/variables/{variable_name}

Parameters

variable_name – string

Return type

bool