Module: Octokit::Client::ActionsSecrets

Relationships & Source Files
Extension / Inclusion / Inheritance Descendants
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)

Create or update an environment secret.
#create_or_update_actions_secret(repo, name, options)

Create or update secrets.
#create_or_update_org_actions_secret(org, name, options)

Create or update org secrets.
#delete_actions_environment_secret(repo, environment, name)

Delete environment secret.
#delete_actions_secret(repo, name)

Delete a secret.
#delete_org_actions_secret(org, name)

Delete an org 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.
#get_org_actions_public_key(org) ⇒ Hash

Get public key for secrets encryption.
#get_org_actions_secret(org, name) ⇒ Hash

Get an org secret.
#list_actions_environment_secrets(repo, environment) ⇒ Hash

List environment secrets.
#list_actions_secrets(repo) ⇒ Hash

List secrets.
#list_org_actions_secrets(org) ⇒ Hash

List org secrets.

Instance Method Details

#create_or_update_actions_environment_secret(repo, environment, name, options)

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

[ GitHub ]

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


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)

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

[ GitHub ]

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


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

#create_or_update_org_actions_secret(org, name, options)

Create or update org secrets

Parameters:

org (String) —
A GitHub organization
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

[ GitHub ]

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


def create_or_update_org_actions_secret(org, name, options)
  put "#{Organization.path org}/actions/secrets/#{name}", options
end

#delete_actions_environment_secret(repo, environment, name)

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

[ GitHub ]

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


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)

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

[ GitHub ]

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


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

#delete_org_actions_secret(org, name)

Delete an org secret

Parameters:

org (String) —
A GitHub organization
name (String) —
Name of secret

See Also:

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

[ GitHub ]

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


def delete_org_actions_secret(org, name)
  boolean_from_response :delete, "#{Organization.path org}/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

[ GitHub ]

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


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

[ GitHub ]

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


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

[ GitHub ]

# 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

[ GitHub ]

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


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

#get_org_actions_public_key(org) ⇒ `Hash`

Get public key for secrets encryption

Parameters:

org (String) —
A GitHub organization

Returns:

(Hash) —
key_id and key

See Also:

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

[ GitHub ]

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


def get_org_actions_public_key(org)
  get "#{Organization.path org}/actions/secrets/public-key"
end

#get_org_actions_secret(org, name) ⇒ `Hash`

Get an org secret

Parameters:

org (String) —
A GitHub organization
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

[ GitHub ]

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


def get_org_actions_secret(org, name)
  get "#{Organization.path org}/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

[ GitHub ]

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


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

[ GitHub ]

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


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

#list_org_actions_secrets(org) ⇒ `Hash`

List org secrets

Parameters:

org (String) —
A GitHub organization

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-organization-secrets

[ GitHub ]

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


def list_org_actions_secrets(org)
  paginate "#{Organization.path org}/actions/secrets" do |data, last_response|
    data.secrets.concat last_response.data.secrets
  end
end

Module: Octokit::Client::ActionsSecrets

Overview

Instance Method Summary

Instance Method Details

#create_or_update_actions_environment_secret(repo, environment, name, options)

#create_or_update_actions_secret(repo, name, options)

#create_or_update_org_actions_secret(org, name, options)

#delete_actions_environment_secret(repo, environment, name)

#delete_actions_secret(repo, name)

#delete_org_actions_secret(org, name)

#get_actions_environment_public_key(repo, environment) ⇒ Hash

#get_actions_environment_secret(repo, environment, name) ⇒ Hash

#get_actions_public_key(repo) ⇒ Hash

#get_actions_secret(repo, name) ⇒ Hash

#get_org_actions_public_key(org) ⇒ Hash

#get_org_actions_secret(org, name) ⇒ Hash

#list_actions_environment_secrets(repo, environment) ⇒ Hash

#list_actions_secrets(repo) ⇒ Hash

#list_org_actions_secrets(org) ⇒ Hash

#get_actions_environment_public_key(repo, environment) ⇒ `Hash`

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

#get_actions_public_key(repo) ⇒ `Hash`

#get_actions_secret(repo, name) ⇒ `Hash`

#get_org_actions_public_key(org) ⇒ `Hash`

#get_org_actions_secret(org, name) ⇒ `Hash`

#list_actions_environment_secrets(repo, environment) ⇒ `Hash`

#list_actions_secrets(repo) ⇒ `Hash`

#list_org_actions_secrets(org) ⇒ `Hash`