github3_utils.secrets
¶
Functions for setting and updating GitHub Actions secrets.
Classes:
|
Functions:
|
Returns the URL via which secrets can be checked and set. |
|
Encrypt a GitHub Actions secret. |
|
Returns the public key used to encrypt secrets for the given repository. |
|
Returns a list of secret names for the given repository. |
|
Set the value of the given secret. |
-
typeddict
PublicKey
[source]¶ typing.TypedDict
representing the return type ofget_public_key()
.
-
build_secrets_url
(repo)[source]¶ Returns the URL via which secrets can be checked and set.
- Parameters
repo (
Repository
) – The repository to check/set secrets for.- Return type
-
encrypt_secret
(public_key, secret_value)[source]¶ Encrypt a GitHub Actions secret.
If the key has been obtained with
get_secrets()
thenpublic_key
will be:get_secrets(repo)['key']
- Return type
-
get_public_key
(repo)[source]¶ Returns the public key used to encrypt secrets for the given repository.
- Parameters
repo (
Repository
) – The repository the secrets are to be set for.- Return type
-
get_secrets
(repo)[source]¶ Returns a list of secret names for the given repository.
- Parameters
repo (
Repository
)- Return type