module GitHub::REST::Secrets
Overview
This module is specifically for interacting with the Secrets endpoints GitHub offers us to use. see GitHub Secrets endpoints
Direct including types
Defined in:
githubcr/rest.crInstance Method Summary
-
#create_or_update_secret
TODO
-
#delete_secret(owner : String, repository : String, name : String) : Nil
NOTE Raises an error when not found
-
#get_my_public_key(owner : String, repository : String) : PublicKey
Gets your public key, which you must store.
- #get_secret(owner : String, repository : String, name : String) : Secrets::SecretData
-
#list_secrets(owner : String, repository : String) : Secrets
NOTE Secrets is NOT an array! it contains an array of SecretData SEE this.
Instance Method Detail
def delete_secret(owner : String, repository : String, name : String) : Nil
#
NOTE Raises an error when not found
Gets your public key, which you must store. You need your public key to use other secrets endpoints. Use the returned key to encrypt your secrets. Anyone with read access to the repository can use this endpoint. GitHub Apps must have the secrets permission to use this endpoint.
def get_secret(owner : String, repository : String, name : String) : Secrets::SecretData
#
NOTE Secrets is NOT an array! it contains an array of SecretData SEE this.