Module: Octokit::Client::ActionsSecrets

Included in:
Octokit::Client
Defined in:
lib/octokit/client/actions_secrets.rb

Overview

Methods for the Actions Secrets API

Instance Method Summary collapse

Instance Method Details

#create_or_update_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:


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

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

#delete_secret(repo, name) ⇒ Object

Delete a secret

Parameters:

  • repo (Integer, String, Hash, Repository)

    A GitHub repository

  • name (String)

    Name of secret

See Also:


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

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

#get_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:


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

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

#get_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:


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

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

#list_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:


24
25
26
# File 'lib/octokit/client/actions_secrets.rb', line 24

def list_secrets(repo)
  paginate "#{Repository.path repo}/actions/secrets"
end