Module: Octokit::Client::ActionsSecrets

Included in:

Octokit::Client

Defined in:

lib/octokit/client/actions_secrets.rb

Overview

Methods for the Actions Secrets API

See Also:

• https://developer.github.com/v3/actions/secrets/

Instance Method Summary

• #create_or_update_actions_environment_secret(repo, environment, name, options) ⇒ Object

  Create or update an environment secret.

• #create_or_update_actions_secret(repo, name, options) ⇒ Object

  Create or update secrets.

• #delete_actions_environment_secret(repo, environment, name) ⇒ Object

  Delete environment secret.

• #delete_actions_secret(repo, name) ⇒ Object

  Delete a secret.

• #get_actions_environment_public_key(repo, environment) ⇒ Hash

  Get environment public key for secrets encryption.

• #get_actions_environment_secret(repo, environment, name) ⇒ Hash

  Get an environment secret.

• #get_actions_public_key(repo) ⇒ Hash

  Get public key for secrets encryption.

• #get_actions_secret(repo, name) ⇒ Hash

  Get a secret.

• #list_actions_environment_secrets(repo, environment) ⇒ Hash

  List environment secrets.

• #list_actions_secrets(repo) ⇒ Hash

  List secrets.

Instance Method Details

#create_or_update_actions_environment_secret(repo, environment, name, options) ⇒ Object

Create or update an environment secret

Parameters:

• repo (Integer, String, Hash, Repository) —

  A GitHub repository

• environment (String) —

  Name of environment

• name (String) —

  Name of secret

• options (Hash) —

  encrypted_value and key_id

See Also:

• https://docs.github.com/en/rest/actions/secrets#create-or-update-an-environment-secret

# File 'lib/octokit/client/actions_secrets.rb', line 98

def create_or_update_actions_environment_secret(repo, environment, name, options)
  put "#{Repository.path repo}/environments/#{environment}/secrets/#{name}", options
end

#create_or_update_actions_secret(repo, name, options) ⇒ Object

Create or update secrets

Parameters:

• repo (Integer, String, Hash, Repository) —

  A GitHub repository

• name (String) —

  Name of secret

• options (Hash) —

  encrypted_value and key_id

See Also:

• https://developer.github.com/v3/actions/secrets/#create-or-update-a-secret-for-a-repository

# File 'lib/octokit/client/actions_secrets.rb', line 45

def create_or_update_actions_secret(repo, name, options)
  put "#{Repository.path repo}/actions/secrets/#{name}", options
end

#delete_actions_environment_secret(repo, environment, name) ⇒ Object

Delete environment secret

Parameters:

• repo (Integer, String, Hash, Repository) —

  A GitHub repository

• environment (String) —

  Name of environment

• name (String) —

  Name of secret

See Also:

• https://docs.github.com/en/rest/actions/secrets#delete-an-environment-secret

# File 'lib/octokit/client/actions_secrets.rb', line 107

def delete_actions_environment_secret(repo, environment, name)
  boolean_from_response :delete, "#{Repository.path repo}/environments/#{environment}/secrets/#{name}"
end

#delete_actions_secret(repo, name) ⇒ Object

Delete a secret

Parameters:

• repo (Integer, String, Hash, Repository) —

  A GitHub repository

• name (String) —

  Name of secret

See Also:

• https://developer.github.com/v3/actions/secrets/#delete-a-secret-from-a-repository

# File 'lib/octokit/client/actions_secrets.rb', line 54

def delete_actions_secret(repo, name)
  boolean_from_response :delete, "#{Repository.path repo}/actions/secrets/#{name}"
end

#get_actions_environment_public_key(repo, environment) ⇒ Hash

Get environment public key for secrets encryption

Parameters:

• repo (Integer, String, Hash, Repository) —

  A GitHub repository

• environment (String) —

  Name of environment

Returns:

• (Hash) —

  key_id and key

See Also:

• https://docs.github.com/en/rest/actions/secrets#get-an-environment-public-key

# File 'lib/octokit/client/actions_secrets.rb', line 64

def get_actions_environment_public_key(repo, environment)
  get "#{Repository.path repo}/environments/#{environment}/secrets/public-key"
end

#get_actions_environment_secret(repo, environment, name) ⇒ Hash

Get an environment secret

Parameters:

• repo (Integer, String, Hash, Repository) —

  A GitHub repository

• environment (String) —

  Name of environment

• name (String) —

  Name of secret

Returns:

• (Hash) —

  name, created_at and updated_at

See Also:

• https://docs.github.com/en/rest/actions/secrets#get-an-environment-secret

# File 'lib/octokit/client/actions_secrets.rb', line 87

def get_actions_environment_secret(repo, environment, name)
  get "#{Repository.path repo}/environments/#{environment}/secrets/#{name}"
end

#get_actions_public_key(repo) ⇒ Hash

Get public key for secrets encryption

Parameters:

• repo (Integer, String, Hash, Repository) —

  A GitHub repository

Returns:

• (Hash) —

  key_id and key

See Also:

• https://developer.github.com/v3/actions/secrets/#get-your-public-key

# File 'lib/octokit/client/actions_secrets.rb', line 14

def get_actions_public_key(repo)
  get "#{Repository.path repo}/actions/secrets/public-key"
end

#get_actions_secret(repo, name) ⇒ Hash

Get a secret

Parameters:

• repo (Integer, String, Hash, Repository) —

  A GitHub repository

• name (String) —

  Name of secret

Returns:

• (Hash) —

  name, created_at and updated_at

See Also:

• https://developer.github.com/v3/actions/secrets/#get-a-secret

# File 'lib/octokit/client/actions_secrets.rb', line 35

def get_actions_secret(repo, name)
  get "#{Repository.path repo}/actions/secrets/#{name}"
end

#list_actions_environment_secrets(repo, environment) ⇒ Hash

List environment secrets

Parameters:

• repo (Integer, String, Hash, Repository) —

  A GitHub repository

• environment (String) —

  Name of environment

Returns:

• (Hash) —

  total_count and list of secrets (each item is hash with name, created_at and updated_at)

See Also:

• https://developer.github.com/v3/actions/secrets/#list-environment-secrets

# File 'lib/octokit/client/actions_secrets.rb', line 74

def list_actions_environment_secrets(repo, environment)
  paginate "#{Repository.path repo}/environments/#{environment}/secrets" do |data, last_response|
    data.secrets.concat last_response.data.secrets
  end
end

#list_actions_secrets(repo) ⇒ Hash

List secrets

Parameters:

• repo (Integer, String, Hash, Repository) —

  A GitHub repository

Returns:

• (Hash) —

  total_count and list of secrets (each item is hash with name, created_at and updated_at)

See Also:

• https://developer.github.com/v3/actions/secrets/#list-secrets-for-a-repository

# File 'lib/octokit/client/actions_secrets.rb', line 23

def list_actions_secrets(repo)
  paginate "#{Repository.path repo}/actions/secrets" do |data, last_response|
    data.secrets.concat last_response.data.secrets
  end
end