Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for Organization Secrets API #1606

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 2 additions & 0 deletions lib/octokit/client.rb
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
require 'octokit/repository'
require 'octokit/user'
require 'octokit/organization'
require 'octokit/client/organization_secrets'
require 'octokit/client/actions_artifacts'
require 'octokit/client/actions_secrets'
require 'octokit/client/actions_workflows'
Expand Down Expand Up @@ -116,6 +117,7 @@ class Client
include Octokit::Client::OauthApplications
include Octokit::Client::Objects
include Octokit::Client::Organizations
include Octokit::Client::OrganizationSecrets
include Octokit::Client::Pages
include Octokit::Client::Projects
include Octokit::Client::PubSubHubbub
Expand Down
59 changes: 59 additions & 0 deletions lib/octokit/client/organization_secrets.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
# frozen_string_literal: true

module Octokit
class Client
# Methods for the Organization Secrets API
#
# @see https://docs.github.com/en/rest/actions/secrets?apiVersion=2022-11-28
module OrganizationSecrets
# Get organization public key for secrets encryption
#
# @param org [Integer, String, Hash, Organization] A GitHub organization
# @return [Hash] key_id and key
# @see https://docs.github.com/en/rest/actions/secrets?apiVersion=2022-11-28#get-an-organization-public-key
def get_org_public_key(org)
get "#{Organization.path org}/actions/secrets/public-key"
end

# List organization secrets
#
# @param org [Integer, String, Hash, Organization] A GitHub organization
# @return [Hash] total_count and list of secrets (each item is hash with name, created_at and updated_at)
# @see https://docs.github.com/en/rest/actions/secrets?apiVersion=2022-11-28#list-repository-organization-secrets
def list_org_secrets(org)
paginate "#{Organization.path org}/actions/secrets" do |data, last_response|
data.secrets.concat last_response.data.secrets
end
end

# Get an organization secret
#
# @param org [Integer, String, Hash, Organization] A GitHub organization
# @param name [String] Name of secret
# @return [Hash] name, created_at, updated_at, visibility, selected_repositories_url
# @see https://docs.github.com/en/rest/actions/secrets?apiVersion=2022-11-28#get-an-organization-secret
def get_org_secret(org, name)
get "#{Organization.path org}/actions/secrets/#{name}"
end

# Create or update organization secrets
#
# @param org [Integer, String, Hash, Organization] A GitHub organization
# @param name [String] Name of secret
# @param options [Hash] encrypted_value, key_id, visibility, and selected_repository_ids
# @see https://docs.github.com/en/rest/actions/secrets?apiVersion=2022-11-28#create-or-update-an-organization-secret
def create_or_update_org_secret(org, name, options)
put "#{Organization.path org}/actions/secrets/#{name}", options
end

# Delete an organization secret
#
# @param org [Integer, String, Hash, Organization] A GitHub organization
# @param name [String] Name of secret
# @see https://docs.github.com/en/rest/actions/secrets?apiVersion=2022-11-28#delete-an-organization-secret
def delete_org_secret(org, name)
boolean_from_response :delete, "#{Organization.path org}/actions/secrets/#{name}"
end
end
end
end