module Octokit::Client::Milestones

def create_milestone(repository, title, options = {})

Other tags:
    Example: Create a milestone for a repository -

Other tags:
    See: https://developer.github.com/v3/issues/milestones/#create-a-milestone -

Returns:
  • (Sawyer::Resource) - A single milestone object

Options Hash: (**options)
  • :due_on (Time) -- Set if the milestone has a due date
  • :description (String) -- A meaningful description
  • :state (String) -- State: open or closed.

Parameters:
  • options (Hash) -- A customizable set of options.
  • title (String) -- A unique title.
  • repository (Integer, String, Repository, Hash) -- A GitHub repository 
def create_milestone(repository, title, options = {})
  post "#{Repository.path repository}/milestones", options.merge({ title: title })
end

def delete_milestone(repository, number, options = {})

Other tags:
    Example: Delete a single milestone from a repository -

Other tags:
    See: https://developer.github.com/v3/issues/milestones/#delete-a-milestone -

Returns:
  • (Boolean) - Success

Options Hash: (**options)
  • :milestone (Integer) -- Milestone number.

Parameters:
  • options (Hash) -- A customizable set of options.
  • repository (Integer, String, Repository, Hash) -- A GitHub repository 
def delete_milestone(repository, number, options = {})
  boolean_from_response :delete, "#{Repository.path repository}/milestones/#{number}", options
end

def list_milestones(repository, options = {})

Other tags:
    Example: List milestones for a repository -

Other tags:
    See: https://developer.github.com/v3/issues/milestones/#list-milestones-for-a-repository -

Returns:
  • (Array) - A list of milestones for a repository.

Options Hash: (**options)
  • :direction (String) -- Direction: asc or desc.
  • :sort (String) -- Sort: created, updated, or comments.
  • :state (String) -- State: open, closed, or all.
  • :milestone (Integer) -- Milestone number.

Parameters:
  • options (Hash) -- A customizable set of options.
  • repository (Integer, String, Repository, Hash) -- A GitHub repository 
def list_milestones(repository, options = {})
  paginate "#{Repository.path repository}/milestones", options
end

def milestone(repository, number, options = {})

Other tags:
    Example: Get a single milestone for a repository -

Other tags:
    See: https://developer.github.com/v3/issues/milestones/#get-a-single-milestone -

Returns:
  • (Sawyer::Resource) - A single milestone from a repository.

Options Hash: (**options)
  • :milestone (Integer) -- Milestone number.

Parameters:
  • options (Hash) -- A customizable set of options.
  • repository (Integer, String, Repository, Hash) -- A GitHub repository 
def milestone(repository, number, options = {})
  get "#{Repository.path repository}/milestones/#{number}", options
end

def update_milestone(repository, number, options = {})

Other tags:
    Example: Update a milestone for a repository -

Other tags:
    See: https://developer.github.com/v3/issues/milestones/#update-a-milestone -

Returns:
  • (Sawyer::Resource) - A single milestone object

Options Hash: (**options)
  • :due_on (Time) -- Set if the milestone has a due date
  • :description (String) -- A meaningful description
  • :state (String) -- State: open or closed.
  • :title (String) -- A unique title.

Parameters:
  • options (Hash) -- A customizable set of options.
  • number (String, Integer) -- ID of the milestone
  • repository (Integer, String, Repository, Hash) -- A GitHub repository 
def update_milestone(repository, number, options = {})
  patch "#{Repository.path repository}/milestones/#{number}", options
end