This commit is contained in:
@@ -0,0 +1,61 @@
|
||||
# frozen_string_literal: true
|
||||
|
||||
module Octokit
|
||||
class Client
|
||||
# Methods for the Pages API
|
||||
#
|
||||
# @see https://developer.github.com/v3/repos/pages/
|
||||
module Pages
|
||||
# List Pages information for a repository
|
||||
#
|
||||
# @param repo [Integer, String, Repository, Hash] A GitHub repository
|
||||
# @return Sawyer::Resource A GitHub Pages resource
|
||||
# @see https://developer.github.com/v3/repos/pages/#get-information-about-a-pages-site
|
||||
def pages(repo, options = {})
|
||||
get "#{Repository.path repo}/pages", options
|
||||
end
|
||||
|
||||
# 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 https://developer.github.com/v3/repos/pages/#list-a-specific-pages-build
|
||||
# @example
|
||||
# Octokit.pages_build("github/developer.github.com", 5472601)
|
||||
def pages_build(repo, id, options = {})
|
||||
get "#{Repository.path repo}/pages/builds/#{id}", options
|
||||
end
|
||||
|
||||
# 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 https://developer.github.com/v3/repos/pages/#list-pages-builds
|
||||
def pages_builds(repo, options = {})
|
||||
get "#{Repository.path repo}/pages/builds", options
|
||||
end
|
||||
alias list_pages_builds pages_builds
|
||||
|
||||
# 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 https://developer.github.com/v3/repos/pages/#list-latest-pages-build
|
||||
def latest_pages_build(repo, options = {})
|
||||
get "#{Repository.path repo}/pages/builds/latest", options
|
||||
end
|
||||
|
||||
# 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 https://developer.github.com/v3/repos/pages/#request-a-page-build
|
||||
def request_page_build(repo, options = {})
|
||||
post "#{Repository.path repo}/pages/builds", options
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
Reference in New Issue
Block a user