module Octokit::Client::Milestones

Methods for the Issues Milestones API

@see developer.github.com/v3/issues/milestones/

Public Instance Methods

create_milestone(repository, title, options = {}) click to toggle source

Create a milestone for a repository

@param repository [Integer, String, Repository, Hash] A GitHub repository @param title [String] A unique title. @param options [Hash] A customizable set of options. @option options [String] :state (open) State: open or closed. @option options [String] :description A meaningful description @option options [Time] :due_on Set if the milestone has a due date @return [Sawyer::Resource] A single milestone object @see developer.github.com/v3/issues/milestones/#create-a-milestone @example Create a milestone for a repository

Octokit.create_milestone("octokit/octokit.rb", "0.7.0", {:description => 'Add support for v3 of Github API'})
# File lib/octokit/client/milestones.rb, line 51
def create_milestone(repository, title, options = {})
  post "#{Repository.path repository}/milestones", options.merge({:title => title})
end
delete_milestone(repository, number, options = {}) click to toggle source

Delete a single milestone for a repository

@param repository [Integer, String, Repository, Hash] A GitHub repository @param options [Hash] A customizable set of options. @option options [Integer] :milestone Milestone number. @return [Boolean] Success @see developer.github.com/v3/issues/milestones/#delete-a-milestone @example Delete a single milestone from a repository

Octokit.delete_milestone("octokit/octokit.rb", 1)
# File lib/octokit/client/milestones.rb, line 82
def delete_milestone(repository, number, options = {})
  boolean_from_response :delete, "#{Repository.path repository}/milestones/#{number}", options
end
edit_milestone(repository, number, options = {})
Alias for: update_milestone
list_milestones(repository, options = {}) click to toggle source

List milestones for a repository

@param repository [Integer, String, Repository, Hash] A GitHub repository @param options [Hash] A customizable set of options. @option options [Integer] :milestone Milestone number. @option options [String] :state (open) State: open, closed, or all. @option options [String] :sort (created) Sort: created, updated, or comments. @option options [String] :direction (desc) Direction: asc or desc. @return [Array<Sawyer::Resource>] A list of milestones for a repository. @see developer.github.com/v3/issues/milestones/#list-milestones-for-a-repository @example List milestones for a repository

Octokit.list_milestones("octokit/octokit.rb")
# File lib/octokit/client/milestones.rb, line 21
def list_milestones(repository, options = {})
  paginate "#{Repository.path repository}/milestones", options
end
Also aliased as: milestones
milestone(repository, number, options = {}) click to toggle source

Get a single milestone for a repository

@param repository [Integer, String, Repository, Hash] A GitHub repository @param options [Hash] A customizable set of options. @option options [Integer] :milestone Milestone number. @return [Sawyer::Resource] A single milestone from a repository. @see developer.github.com/v3/issues/milestones/#get-a-single-milestone @example Get a single milestone for a repository

Octokit.milestone("octokit/octokit.rb", 1)
# File lib/octokit/client/milestones.rb, line 35
def milestone(repository, number, options = {})
  get "#{Repository.path repository}/milestones/#{number}", options
end
milestones(repository, options = {})
Alias for: list_milestones
update_milestone(repository, number, options = {}) click to toggle source

Update a milestone for a repository

@param repository [Integer, String, Repository, Hash] A GitHub repository @param number [String, Integer] ID of the milestone @param options [Hash] A customizable set of options. @option options [String] :title A unique title. @option options [String] :state (open) State: open or closed. @option options [String] :description A meaningful description @option options [Time] :due_on Set if the milestone has a due date @return [Sawyer::Resource] A single milestone object @see developer.github.com/v3/issues/milestones/#update-a-milestone @example Update a milestone for a repository

Octokit.update_milestone("octokit/octokit.rb", 1, {:description => 'Add support for v3 of Github API'})
# File lib/octokit/client/milestones.rb, line 68
def update_milestone(repository, number, options = {})
  patch "#{Repository.path repository}/milestones/#{number}", options
end
Also aliased as: edit_milestone