Module: Octokit::Client::Environments

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

Overview

Methods for the Environments API

See Also:

Instance Method Summary collapse

Instance Method Details

#create_or_update_environment(repo, environment_name, options = {}) ⇒ Sawyer::Resource

Create or update an environment with protection rules, such as required reviewers

Parameters:

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

    A GitHub repository

  • environment_name (String) —

    The name of the environment

  • options (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (options):

  • :wait_timer (Integer) —

    The amount of time to delay a job after the job is initially triggered. The time (in minutes) must be an integer between 0 and 43,200 (30 days).

  • :reviewers (Array) —

    The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers.

  • :deployment_branch_policy (Object) —

    The type of deployment branch policy for this environment. To allow all branches to deploy, set to null.

Returns:

  • (Sawyer::Resource) —

    An environment

See Also:



40
41
42
 
# File 'lib/octokit/client/environments.rb', line 40

def create_or_update_environment(repo, environment_name, options = {})
  put("#{Repository.path repo}/environments/#{environment_name}", options)
end

#delete_environment(repo, environment_name, options = {}) ⇒ No Content

Delete an Environment

Parameters:

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

    A GitHub repository

  • environment_name (String) —

    The name of the environment

Returns:

  • (No Content)

See Also:



50
51
52
 
# File 'lib/octokit/client/environments.rb', line 50

def delete_environment(repo, environment_name, options = {})
  delete("#{Repository.path repo}/environments/#{environment_name}", options)
end

#environment(repo, environment_name, options = {}) ⇒ Sawyer::Resource

Fetch a single environment for a repository

Parameters:

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

    A GitHub repository

  • environment_name (String) —

    The name of the environment

Returns:

  • (Sawyer::Resource) —

    A single environment

See Also:



15
16
17
 
# File 'lib/octokit/client/environments.rb', line 15

def environment(repo, environment_name, options = {})
  get("#{Repository.path repo}/environments/#{environment_name}", options)
end

#environments(repo, options = {}) ⇒ Sawyer::Resource Also known as: list_environments

Lists the environments for a repository

Parameters:

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

    A GitHub repository

  • options (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (options):

  • :per_page (Integer) —

    The number of results per page (max 100). Default: 30

  • :page (Integer) —

    Page number of the results to fetch. Default: 1

Returns:

  • (Sawyer::Resource) —

    Total count of environments and list of environments

See Also:



26
27
28
 
# File 'lib/octokit/client/environments.rb', line 26

def environments(repo, options = {})
  get("#{Repository.path repo}/environments", options)
end