Variable

class github.Variable.Variable

This class represents a GitHub variable.

The reference can be found here https://docs.github.com/en/rest/actions/variables

The OpenAPI schema can be found at

  • /components/schemas/actions-variable

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 created_at: datetime
Type:

datetime.datetime

property name: str
Type:

string

property updated_at: datetime
Type:

datetime.datetime

property url: str
Type:

string

property value: str
Type:

string

property variables_url: str
Type:

string

edit(value: str) → bool
Calls:

PATCH /repos/{owner}/{repo}/actions/variables/{name}

Parameters:

  • variable_name – string

  • value – string

Return type:

bool

delete() → None
Calls:

DELETE /orgs/{org}/actions/variables/{name}

Calls:

DELETE /repos/{owner}/{repo}/actions/variables/{name}

Calls:

DELETE /repos/{owner}/{repo}/environments/{environment_name}/variables/{name}

Return type:

None