module Octokit::Client::Pages

Methods for the Pages API

@see developer.github.com/v3/repos/pages/

Public Instance Methods

latest_pages_build(repo, options = {}) click to toggle source

List the latest Pages build information for a repository

@param repo [Integer, String, Repository, Hash] A GitHub repository @return Sawyer::Resource A GitHub Pages resource about a build @see developer.github.com/v3/repos/pages/#list-latest-pages-build

# File lib/octokit/client/pages.rb, line 46
def latest_pages_build(repo, options = {})
  get "#{Repository.path repo}/pages/builds/latest", options
end
list_pages_builds(repo, options = {})
Alias for: pages_builds
pages(repo, options = {}) click to toggle source

List Pages information for a repository

@param repo [Integer, String, Repository, Hash] A GitHub repository @return Sawyer::Resource A GitHub Pages resource @see developer.github.com/v3/repos/pages/#get-information-about-a-pages-site

# File lib/octokit/client/pages.rb, line 14
def pages(repo, options = {})
  get "#{Repository.path repo}/pages", options
end
pages_build(repo, id, options = {}) click to toggle source

Get a specific Pages build by ID

@param repo [Integer, String, Repository, Hash] A GitHub repository @param id [Integer, String] Build ID @return [Sawyer::Resource] Pages build information @see developer.github.com/v3/repos/pages/#list-a-specific-pages-build @example

Octokit.pages_build("github/developer.github.com", 5472601)
# File lib/octokit/client/pages.rb, line 26
def pages_build(repo, id, options = {})
  opts = ensure_api_media_type(:pages, options)
  get "#{Repository.path repo}/pages/builds/#{id}", opts
end
pages_builds(repo, options = {}) click to toggle source

List Pages builds for a repository

@param repo [Integer, String, Repository, Hash] A GitHub repository @return [Array<Sawyer::Resource>] A list of build history for a repository. @see developer.github.com/v3/repos/pages/#list-pages-builds

# File lib/octokit/client/pages.rb, line 36
def pages_builds(repo, options = {})
  get "#{Repository.path repo}/pages/builds", options
end
Also aliased as: list_pages_builds
request_page_build(repo, options = {}) click to toggle source

Request a page build for the latest revision of the default branch

You can only request builds for your repositories

@param repo [Integer, String, Repository, Hash] A GitHub repository @return [Sawyer::Resource] Request result @see developer.github.com/v3/repos/pages/#request-a-page-build

# File lib/octokit/client/pages.rb, line 57
def request_page_build(repo, options = {})
  opts = ensure_api_media_type(:pages, options)
  post "#{Repository.path repo}/pages/builds", opts
end