2019-05-06 21:12:51 -04:00
// Copyright 2013 The go-github AUTHORS. All rights reserved.
//
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
package github
import (
"context"
2020-07-31 10:22:34 -04:00
"encoding/json"
2019-05-06 21:12:51 -04:00
"fmt"
2021-08-10 05:49:43 -04:00
"net/http"
2019-05-06 21:12:51 -04:00
"strings"
)
// RepositoriesService handles communication with the repository related
// methods of the GitHub API.
//
2021-08-10 05:49:43 -04:00
// GitHub API docs: https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/
2019-05-06 21:12:51 -04:00
type RepositoriesService service
// Repository represents a GitHub repository.
type Repository struct {
2021-08-10 05:49:43 -04:00
ID * int64 ` json:"id,omitempty" `
NodeID * string ` json:"node_id,omitempty" `
Owner * User ` json:"owner,omitempty" `
Name * string ` json:"name,omitempty" `
FullName * string ` json:"full_name,omitempty" `
Description * string ` json:"description,omitempty" `
Homepage * string ` json:"homepage,omitempty" `
CodeOfConduct * CodeOfConduct ` json:"code_of_conduct,omitempty" `
DefaultBranch * string ` json:"default_branch,omitempty" `
MasterBranch * string ` json:"master_branch,omitempty" `
CreatedAt * Timestamp ` json:"created_at,omitempty" `
PushedAt * Timestamp ` json:"pushed_at,omitempty" `
UpdatedAt * Timestamp ` json:"updated_at,omitempty" `
HTMLURL * string ` json:"html_url,omitempty" `
CloneURL * string ` json:"clone_url,omitempty" `
GitURL * string ` json:"git_url,omitempty" `
MirrorURL * string ` json:"mirror_url,omitempty" `
SSHURL * string ` json:"ssh_url,omitempty" `
SVNURL * string ` json:"svn_url,omitempty" `
Language * string ` json:"language,omitempty" `
Fork * bool ` json:"fork,omitempty" `
ForksCount * int ` json:"forks_count,omitempty" `
NetworkCount * int ` json:"network_count,omitempty" `
OpenIssuesCount * int ` json:"open_issues_count,omitempty" `
OpenIssues * int ` json:"open_issues,omitempty" ` // Deprecated: Replaced by OpenIssuesCount. For backward compatibility OpenIssues is still populated.
StargazersCount * int ` json:"stargazers_count,omitempty" `
SubscribersCount * int ` json:"subscribers_count,omitempty" `
WatchersCount * int ` json:"watchers_count,omitempty" ` // Deprecated: Replaced by StargazersCount. For backward compatibility WatchersCount is still populated.
Watchers * int ` json:"watchers,omitempty" ` // Deprecated: Replaced by StargazersCount. For backward compatibility Watchers is still populated.
Size * int ` json:"size,omitempty" `
AutoInit * bool ` json:"auto_init,omitempty" `
Parent * Repository ` json:"parent,omitempty" `
Source * Repository ` json:"source,omitempty" `
TemplateRepository * Repository ` json:"template_repository,omitempty" `
Organization * Organization ` json:"organization,omitempty" `
Permissions map [ string ] bool ` json:"permissions,omitempty" `
AllowRebaseMerge * bool ` json:"allow_rebase_merge,omitempty" `
AllowSquashMerge * bool ` json:"allow_squash_merge,omitempty" `
AllowMergeCommit * bool ` json:"allow_merge_commit,omitempty" `
DeleteBranchOnMerge * bool ` json:"delete_branch_on_merge,omitempty" `
Topics [ ] string ` json:"topics,omitempty" `
Archived * bool ` json:"archived,omitempty" `
Disabled * bool ` json:"disabled,omitempty" `
2019-05-06 21:12:51 -04:00
// Only provided when using RepositoriesService.Get while in preview
License * License ` json:"license,omitempty" `
// Additional mutable fields when creating and editing a repository
Private * bool ` json:"private,omitempty" `
HasIssues * bool ` json:"has_issues,omitempty" `
HasWiki * bool ` json:"has_wiki,omitempty" `
HasPages * bool ` json:"has_pages,omitempty" `
HasProjects * bool ` json:"has_projects,omitempty" `
HasDownloads * bool ` json:"has_downloads,omitempty" `
2020-07-31 10:22:34 -04:00
IsTemplate * bool ` json:"is_template,omitempty" `
2019-05-06 21:12:51 -04:00
LicenseTemplate * string ` json:"license_template,omitempty" `
GitignoreTemplate * string ` json:"gitignore_template,omitempty" `
// Creating an organization repository. Required for non-owners.
TeamID * int64 ` json:"team_id,omitempty" `
// API URLs
URL * string ` json:"url,omitempty" `
ArchiveURL * string ` json:"archive_url,omitempty" `
AssigneesURL * string ` json:"assignees_url,omitempty" `
BlobsURL * string ` json:"blobs_url,omitempty" `
BranchesURL * string ` json:"branches_url,omitempty" `
CollaboratorsURL * string ` json:"collaborators_url,omitempty" `
CommentsURL * string ` json:"comments_url,omitempty" `
CommitsURL * string ` json:"commits_url,omitempty" `
CompareURL * string ` json:"compare_url,omitempty" `
ContentsURL * string ` json:"contents_url,omitempty" `
ContributorsURL * string ` json:"contributors_url,omitempty" `
DeploymentsURL * string ` json:"deployments_url,omitempty" `
DownloadsURL * string ` json:"downloads_url,omitempty" `
EventsURL * string ` json:"events_url,omitempty" `
ForksURL * string ` json:"forks_url,omitempty" `
GitCommitsURL * string ` json:"git_commits_url,omitempty" `
GitRefsURL * string ` json:"git_refs_url,omitempty" `
GitTagsURL * string ` json:"git_tags_url,omitempty" `
HooksURL * string ` json:"hooks_url,omitempty" `
IssueCommentURL * string ` json:"issue_comment_url,omitempty" `
IssueEventsURL * string ` json:"issue_events_url,omitempty" `
IssuesURL * string ` json:"issues_url,omitempty" `
KeysURL * string ` json:"keys_url,omitempty" `
LabelsURL * string ` json:"labels_url,omitempty" `
LanguagesURL * string ` json:"languages_url,omitempty" `
MergesURL * string ` json:"merges_url,omitempty" `
MilestonesURL * string ` json:"milestones_url,omitempty" `
NotificationsURL * string ` json:"notifications_url,omitempty" `
PullsURL * string ` json:"pulls_url,omitempty" `
ReleasesURL * string ` json:"releases_url,omitempty" `
StargazersURL * string ` json:"stargazers_url,omitempty" `
StatusesURL * string ` json:"statuses_url,omitempty" `
SubscribersURL * string ` json:"subscribers_url,omitempty" `
SubscriptionURL * string ` json:"subscription_url,omitempty" `
TagsURL * string ` json:"tags_url,omitempty" `
TreesURL * string ` json:"trees_url,omitempty" `
TeamsURL * string ` json:"teams_url,omitempty" `
// TextMatches is only populated from search results that request text matches
2021-08-10 05:49:43 -04:00
// See: search.go and https://docs.github.com/en/free-pro-team@latest/rest/reference/search/#text-match-metadata
2020-07-31 10:22:34 -04:00
TextMatches [ ] * TextMatch ` json:"text_matches,omitempty" `
// Visibility is only used for Create and Edit endpoints. The visibility field
// overrides the field parameter when both are used.
// Can be one of public, private or internal.
Visibility * string ` json:"visibility,omitempty" `
2019-05-06 21:12:51 -04:00
}
func ( r Repository ) String ( ) string {
return Stringify ( r )
}
2020-07-31 10:22:34 -04:00
// BranchListOptions specifies the optional parameters to the
// RepositoriesService.ListBranches method.
type BranchListOptions struct {
// Setting to true returns only protected branches.
// When set to false, only unprotected branches are returned.
// Omitting this parameter returns all branches.
// Default: nil
Protected * bool ` url:"protected,omitempty" `
ListOptions
}
2019-05-06 21:12:51 -04:00
// RepositoryListOptions specifies the optional parameters to the
// RepositoriesService.List method.
type RepositoryListOptions struct {
// Visibility of repositories to list. Can be one of all, public, or private.
// Default: all
Visibility string ` url:"visibility,omitempty" `
// List repos of given affiliation[s].
// Comma-separated list of values. Can include:
// * owner: Repositories that are owned by the authenticated user.
// * collaborator: Repositories that the user has been added to as a
// collaborator.
// * organization_member: Repositories that the user has access to through
// being a member of an organization. This includes every repository on
// every team that the user is on.
// Default: owner,collaborator,organization_member
Affiliation string ` url:"affiliation,omitempty" `
// Type of repositories to list.
// Can be one of all, owner, public, private, member. Default: all
// Will cause a 422 error if used in the same request as visibility or
// affiliation.
Type string ` url:"type,omitempty" `
// How to sort the repository list. Can be one of created, updated, pushed,
// full_name. Default: full_name
Sort string ` url:"sort,omitempty" `
// Direction in which to sort repositories. Can be one of asc or desc.
// Default: when using full_name: asc; otherwise desc
Direction string ` url:"direction,omitempty" `
ListOptions
}
// List the repositories for a user. Passing the empty string will list
// repositories for the authenticated user.
//
2021-08-10 05:49:43 -04:00
// GitHub API docs: https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#list-repositories-for-the-authenticated-user
// GitHub API docs: https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#list-repositories-for-a-user
2020-07-31 10:22:34 -04:00
func ( s * RepositoriesService ) List ( ctx context . Context , user string , opts * RepositoryListOptions ) ( [ ] * Repository , * Response , error ) {
2019-05-06 21:12:51 -04:00
var u string
if user != "" {
u = fmt . Sprintf ( "users/%v/repos" , user )
} else {
u = "user/repos"
}
2020-07-31 10:22:34 -04:00
u , err := addOptions ( u , opts )
2019-05-06 21:12:51 -04:00
if err != nil {
return nil , nil , err
}
req , err := s . client . NewRequest ( "GET" , u , nil )
if err != nil {
return nil , nil , err
}
// TODO: remove custom Accept headers when APIs fully launch.
2021-08-10 05:49:43 -04:00
acceptHeaders := [ ] string { mediaTypeTopicsPreview , mediaTypeRepositoryVisibilityPreview }
2019-05-06 21:12:51 -04:00
req . Header . Set ( "Accept" , strings . Join ( acceptHeaders , ", " ) )
var repos [ ] * Repository
resp , err := s . client . Do ( ctx , req , & repos )
if err != nil {
return nil , resp , err
}
return repos , resp , nil
}
// RepositoryListByOrgOptions specifies the optional parameters to the
// RepositoriesService.ListByOrg method.
type RepositoryListByOrgOptions struct {
// Type of repositories to list. Possible values are: all, public, private,
// forks, sources, member. Default is "all".
Type string ` url:"type,omitempty" `
2020-07-31 10:22:34 -04:00
// How to sort the repository list. Can be one of created, updated, pushed,
// full_name. Default is "created".
Sort string ` url:"sort,omitempty" `
// Direction in which to sort repositories. Can be one of asc or desc.
// Default when using full_name: asc; otherwise desc.
Direction string ` url:"direction,omitempty" `
2019-05-06 21:12:51 -04:00
ListOptions
}
// ListByOrg lists the repositories for an organization.
//
2021-08-10 05:49:43 -04:00
// GitHub API docs: https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#list-organization-repositories
2020-07-31 10:22:34 -04:00
func ( s * RepositoriesService ) ListByOrg ( ctx context . Context , org string , opts * RepositoryListByOrgOptions ) ( [ ] * Repository , * Response , error ) {
2019-05-06 21:12:51 -04:00
u := fmt . Sprintf ( "orgs/%v/repos" , org )
2020-07-31 10:22:34 -04:00
u , err := addOptions ( u , opts )
2019-05-06 21:12:51 -04:00
if err != nil {
return nil , nil , err
}
req , err := s . client . NewRequest ( "GET" , u , nil )
if err != nil {
return nil , nil , err
}
// TODO: remove custom Accept headers when APIs fully launch.
2021-08-10 05:49:43 -04:00
acceptHeaders := [ ] string { mediaTypeTopicsPreview , mediaTypeRepositoryVisibilityPreview }
2019-05-06 21:12:51 -04:00
req . Header . Set ( "Accept" , strings . Join ( acceptHeaders , ", " ) )
var repos [ ] * Repository
resp , err := s . client . Do ( ctx , req , & repos )
if err != nil {
return nil , resp , err
}
return repos , resp , nil
}
// RepositoryListAllOptions specifies the optional parameters to the
// RepositoriesService.ListAll method.
type RepositoryListAllOptions struct {
// ID of the last repository seen
Since int64 ` url:"since,omitempty" `
}
// ListAll lists all GitHub repositories in the order that they were created.
//
2021-08-10 05:49:43 -04:00
// GitHub API docs: https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#list-public-repositories
2020-07-31 10:22:34 -04:00
func ( s * RepositoriesService ) ListAll ( ctx context . Context , opts * RepositoryListAllOptions ) ( [ ] * Repository , * Response , error ) {
u , err := addOptions ( "repositories" , opts )
2019-05-06 21:12:51 -04:00
if err != nil {
return nil , nil , err
}
req , err := s . client . NewRequest ( "GET" , u , nil )
if err != nil {
return nil , nil , err
}
var repos [ ] * Repository
resp , err := s . client . Do ( ctx , req , & repos )
if err != nil {
return nil , resp , err
}
return repos , resp , nil
}
// createRepoRequest is a subset of Repository and is used internally
// by Create to pass only the known fields for the endpoint.
//
// See https://github.com/google/go-github/issues/1014 for more
// information.
type createRepoRequest struct {
// Name is required when creating a repo.
Name * string ` json:"name,omitempty" `
Description * string ` json:"description,omitempty" `
Homepage * string ` json:"homepage,omitempty" `
2020-07-31 10:22:34 -04:00
Private * bool ` json:"private,omitempty" `
Visibility * string ` json:"visibility,omitempty" `
HasIssues * bool ` json:"has_issues,omitempty" `
HasProjects * bool ` json:"has_projects,omitempty" `
HasWiki * bool ` json:"has_wiki,omitempty" `
IsTemplate * bool ` json:"is_template,omitempty" `
2019-05-06 21:12:51 -04:00
// Creating an organization repository. Required for non-owners.
TeamID * int64 ` json:"team_id,omitempty" `
2020-07-31 10:22:34 -04:00
AutoInit * bool ` json:"auto_init,omitempty" `
GitignoreTemplate * string ` json:"gitignore_template,omitempty" `
LicenseTemplate * string ` json:"license_template,omitempty" `
AllowSquashMerge * bool ` json:"allow_squash_merge,omitempty" `
AllowMergeCommit * bool ` json:"allow_merge_commit,omitempty" `
AllowRebaseMerge * bool ` json:"allow_rebase_merge,omitempty" `
DeleteBranchOnMerge * bool ` json:"delete_branch_on_merge,omitempty" `
2019-05-06 21:12:51 -04:00
}
// Create a new repository. If an organization is specified, the new
// repository will be created under that org. If the empty string is
// specified, it will be created for the authenticated user.
//
// Note that only a subset of the repo fields are used and repo must
// not be nil.
//
2021-08-10 05:49:43 -04:00
// Also note that this method will return the response without actually
// waiting for GitHub to finish creating the repository and letting the
// changes propagate throughout its servers. You may set up a loop with
// exponential back-off to verify repository's creation.
//
// GitHub API docs: https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#create-a-repository-for-the-authenticated-user
// GitHub API docs: https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#create-an-organization-repository
2019-05-06 21:12:51 -04:00
func ( s * RepositoriesService ) Create ( ctx context . Context , org string , repo * Repository ) ( * Repository , * Response , error ) {
var u string
if org != "" {
u = fmt . Sprintf ( "orgs/%v/repos" , org )
} else {
u = "user/repos"
}
repoReq := & createRepoRequest {
2020-07-31 10:22:34 -04:00
Name : repo . Name ,
Description : repo . Description ,
Homepage : repo . Homepage ,
Private : repo . Private ,
Visibility : repo . Visibility ,
HasIssues : repo . HasIssues ,
HasProjects : repo . HasProjects ,
HasWiki : repo . HasWiki ,
IsTemplate : repo . IsTemplate ,
TeamID : repo . TeamID ,
AutoInit : repo . AutoInit ,
GitignoreTemplate : repo . GitignoreTemplate ,
LicenseTemplate : repo . LicenseTemplate ,
AllowSquashMerge : repo . AllowSquashMerge ,
AllowMergeCommit : repo . AllowMergeCommit ,
AllowRebaseMerge : repo . AllowRebaseMerge ,
DeleteBranchOnMerge : repo . DeleteBranchOnMerge ,
2019-05-06 21:12:51 -04:00
}
req , err := s . client . NewRequest ( "POST" , u , repoReq )
if err != nil {
return nil , nil , err
}
2020-07-31 10:22:34 -04:00
acceptHeaders := [ ] string { mediaTypeRepositoryTemplatePreview , mediaTypeRepositoryVisibilityPreview }
req . Header . Set ( "Accept" , strings . Join ( acceptHeaders , ", " ) )
r := new ( Repository )
resp , err := s . client . Do ( ctx , req , r )
if err != nil {
return nil , resp , err
}
return r , resp , nil
}
// TemplateRepoRequest represents a request to create a repository from a template.
type TemplateRepoRequest struct {
// Name is required when creating a repo.
Name * string ` json:"name,omitempty" `
Owner * string ` json:"owner,omitempty" `
Description * string ` json:"description,omitempty" `
2021-08-10 05:49:43 -04:00
IncludeAllBranches * bool ` json:"include_all_branches,omitempty" `
Private * bool ` json:"private,omitempty" `
2020-07-31 10:22:34 -04:00
}
// CreateFromTemplate generates a repository from a template.
//
2021-08-10 05:49:43 -04:00
// GitHub API docs: https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#create-a-repository-using-a-template
2020-07-31 10:22:34 -04:00
func ( s * RepositoriesService ) CreateFromTemplate ( ctx context . Context , templateOwner , templateRepo string , templateRepoReq * TemplateRepoRequest ) ( * Repository , * Response , error ) {
u := fmt . Sprintf ( "repos/%v/%v/generate" , templateOwner , templateRepo )
req , err := s . client . NewRequest ( "POST" , u , templateRepoReq )
if err != nil {
return nil , nil , err
}
req . Header . Set ( "Accept" , mediaTypeRepositoryTemplatePreview )
2019-05-06 21:12:51 -04:00
r := new ( Repository )
resp , err := s . client . Do ( ctx , req , r )
if err != nil {
return nil , resp , err
}
return r , resp , nil
}
// Get fetches a repository.
//
2021-08-10 05:49:43 -04:00
// GitHub API docs: https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#get-a-repository
2019-05-06 21:12:51 -04:00
func ( s * RepositoriesService ) Get ( ctx context . Context , owner , repo string ) ( * Repository , * Response , error ) {
u := fmt . Sprintf ( "repos/%v/%v" , owner , repo )
req , err := s . client . NewRequest ( "GET" , u , nil )
if err != nil {
return nil , nil , err
}
// TODO: remove custom Accept header when the license support fully launches
2021-08-10 05:49:43 -04:00
// https://docs.github.com/en/free-pro-team@latest/rest/reference/licenses/#get-a-repositorys-license
2020-07-31 10:22:34 -04:00
acceptHeaders := [ ] string {
mediaTypeCodesOfConductPreview ,
mediaTypeTopicsPreview ,
mediaTypeRepositoryTemplatePreview ,
mediaTypeRepositoryVisibilityPreview ,
}
2019-05-06 21:12:51 -04:00
req . Header . Set ( "Accept" , strings . Join ( acceptHeaders , ", " ) )
repository := new ( Repository )
resp , err := s . client . Do ( ctx , req , repository )
if err != nil {
return nil , resp , err
}
return repository , resp , nil
}
// GetCodeOfConduct gets the contents of a repository's code of conduct.
//
2021-08-10 05:49:43 -04:00
// GitHub API docs: https://docs.github.com/en/free-pro-team@latest/rest/reference/codes-of-conduct/#get-the-code-of-conduct-for-a-repository
2019-05-06 21:12:51 -04:00
func ( s * RepositoriesService ) GetCodeOfConduct ( ctx context . Context , owner , repo string ) ( * CodeOfConduct , * Response , error ) {
u := fmt . Sprintf ( "repos/%v/%v/community/code_of_conduct" , owner , repo )
req , err := s . client . NewRequest ( "GET" , u , nil )
if err != nil {
return nil , nil , err
}
// TODO: remove custom Accept header when this API fully launches.
req . Header . Set ( "Accept" , mediaTypeCodesOfConductPreview )
coc := new ( CodeOfConduct )
resp , err := s . client . Do ( ctx , req , coc )
if err != nil {
return nil , resp , err
}
return coc , resp , nil
}
// GetByID fetches a repository.
//
// Note: GetByID uses the undocumented GitHub API endpoint /repositories/:id.
func ( s * RepositoriesService ) GetByID ( ctx context . Context , id int64 ) ( * Repository , * Response , error ) {
u := fmt . Sprintf ( "repositories/%d" , id )
req , err := s . client . NewRequest ( "GET" , u , nil )
if err != nil {
return nil , nil , err
}
repository := new ( Repository )
resp , err := s . client . Do ( ctx , req , repository )
if err != nil {
return nil , resp , err
}
return repository , resp , nil
}
// Edit updates a repository.
//
2021-08-10 05:49:43 -04:00
// GitHub API docs: https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#update-a-repository
2019-05-06 21:12:51 -04:00
func ( s * RepositoriesService ) Edit ( ctx context . Context , owner , repo string , repository * Repository ) ( * Repository , * Response , error ) {
u := fmt . Sprintf ( "repos/%v/%v" , owner , repo )
req , err := s . client . NewRequest ( "PATCH" , u , repository )
if err != nil {
return nil , nil , err
}
2020-07-31 10:22:34 -04:00
acceptHeaders := [ ] string { mediaTypeRepositoryTemplatePreview , mediaTypeRepositoryVisibilityPreview }
req . Header . Set ( "Accept" , strings . Join ( acceptHeaders , ", " ) )
2019-05-06 21:12:51 -04:00
r := new ( Repository )
resp , err := s . client . Do ( ctx , req , r )
if err != nil {
return nil , resp , err
}
return r , resp , nil
}
// Delete a repository.
//
2021-08-10 05:49:43 -04:00
// GitHub API docs: https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#delete-a-repository
2019-05-06 21:12:51 -04:00
func ( s * RepositoriesService ) Delete ( ctx context . Context , owner , repo string ) ( * Response , error ) {
u := fmt . Sprintf ( "repos/%v/%v" , owner , repo )
req , err := s . client . NewRequest ( "DELETE" , u , nil )
if err != nil {
return nil , err
}
return s . client . Do ( ctx , req , nil )
}
// Contributor represents a repository contributor
type Contributor struct {
Login * string ` json:"login,omitempty" `
ID * int64 ` json:"id,omitempty" `
2020-07-31 10:22:34 -04:00
NodeID * string ` json:"node_id,omitempty" `
2019-05-06 21:12:51 -04:00
AvatarURL * string ` json:"avatar_url,omitempty" `
GravatarID * string ` json:"gravatar_id,omitempty" `
URL * string ` json:"url,omitempty" `
HTMLURL * string ` json:"html_url,omitempty" `
FollowersURL * string ` json:"followers_url,omitempty" `
FollowingURL * string ` json:"following_url,omitempty" `
GistsURL * string ` json:"gists_url,omitempty" `
StarredURL * string ` json:"starred_url,omitempty" `
SubscriptionsURL * string ` json:"subscriptions_url,omitempty" `
OrganizationsURL * string ` json:"organizations_url,omitempty" `
ReposURL * string ` json:"repos_url,omitempty" `
EventsURL * string ` json:"events_url,omitempty" `
ReceivedEventsURL * string ` json:"received_events_url,omitempty" `
Type * string ` json:"type,omitempty" `
SiteAdmin * bool ` json:"site_admin,omitempty" `
Contributions * int ` json:"contributions,omitempty" `
2021-08-10 05:49:43 -04:00
Name * string ` json:"name,omitempty" `
Email * string ` json:"email,omitempty" `
2019-05-06 21:12:51 -04:00
}
// ListContributorsOptions specifies the optional parameters to the
// RepositoriesService.ListContributors method.
type ListContributorsOptions struct {
// Include anonymous contributors in results or not
Anon string ` url:"anon,omitempty" `
ListOptions
}
2020-07-31 10:22:34 -04:00
// GetVulnerabilityAlerts checks if vulnerability alerts are enabled for a repository.
//
2021-08-10 05:49:43 -04:00
// GitHub API docs: https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#check-if-vulnerability-alerts-are-enabled-for-a-repository
2020-07-31 10:22:34 -04:00
func ( s * RepositoriesService ) GetVulnerabilityAlerts ( ctx context . Context , owner , repository string ) ( bool , * Response , error ) {
u := fmt . Sprintf ( "repos/%v/%v/vulnerability-alerts" , owner , repository )
req , err := s . client . NewRequest ( "GET" , u , nil )
if err != nil {
return false , nil , err
}
// TODO: remove custom Accept header when this API fully launches
req . Header . Set ( "Accept" , mediaTypeRequiredVulnerabilityAlertsPreview )
resp , err := s . client . Do ( ctx , req , nil )
vulnerabilityAlertsEnabled , err := parseBoolResponse ( err )
return vulnerabilityAlertsEnabled , resp , err
}
// EnableVulnerabilityAlerts enables vulnerability alerts and the dependency graph for a repository.
//
2021-08-10 05:49:43 -04:00
// GitHub API docs: https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#enable-vulnerability-alerts
2020-07-31 10:22:34 -04:00
func ( s * RepositoriesService ) EnableVulnerabilityAlerts ( ctx context . Context , owner , repository string ) ( * Response , error ) {
u := fmt . Sprintf ( "repos/%v/%v/vulnerability-alerts" , owner , repository )
req , err := s . client . NewRequest ( "PUT" , u , nil )
if err != nil {
return nil , err
}
// TODO: remove custom Accept header when this API fully launches
req . Header . Set ( "Accept" , mediaTypeRequiredVulnerabilityAlertsPreview )
return s . client . Do ( ctx , req , nil )
}
// DisableVulnerabilityAlerts disables vulnerability alerts and the dependency graph for a repository.
//
2021-08-10 05:49:43 -04:00
// GitHub API docs: https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#disable-vulnerability-alerts
2020-07-31 10:22:34 -04:00
func ( s * RepositoriesService ) DisableVulnerabilityAlerts ( ctx context . Context , owner , repository string ) ( * Response , error ) {
u := fmt . Sprintf ( "repos/%v/%v/vulnerability-alerts" , owner , repository )
req , err := s . client . NewRequest ( "DELETE" , u , nil )
if err != nil {
return nil , err
}
// TODO: remove custom Accept header when this API fully launches
req . Header . Set ( "Accept" , mediaTypeRequiredVulnerabilityAlertsPreview )
return s . client . Do ( ctx , req , nil )
}
// EnableAutomatedSecurityFixes enables the automated security fixes for a repository.
//
2021-08-10 05:49:43 -04:00
// GitHub API docs: https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#enable-automated-security-fixes
2020-07-31 10:22:34 -04:00
func ( s * RepositoriesService ) EnableAutomatedSecurityFixes ( ctx context . Context , owner , repository string ) ( * Response , error ) {
u := fmt . Sprintf ( "repos/%v/%v/automated-security-fixes" , owner , repository )
req , err := s . client . NewRequest ( "PUT" , u , nil )
if err != nil {
return nil , err
}
// TODO: remove custom Accept header when this API fully launches
req . Header . Set ( "Accept" , mediaTypeRequiredAutomatedSecurityFixesPreview )
return s . client . Do ( ctx , req , nil )
}
// DisableAutomatedSecurityFixes disables vulnerability alerts and the dependency graph for a repository.
//
2021-08-10 05:49:43 -04:00
// GitHub API docs: https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#disable-automated-security-fixes
2020-07-31 10:22:34 -04:00
func ( s * RepositoriesService ) DisableAutomatedSecurityFixes ( ctx context . Context , owner , repository string ) ( * Response , error ) {
u := fmt . Sprintf ( "repos/%v/%v/automated-security-fixes" , owner , repository )
req , err := s . client . NewRequest ( "DELETE" , u , nil )
if err != nil {
return nil , err
}
// TODO: remove custom Accept header when this API fully launches
req . Header . Set ( "Accept" , mediaTypeRequiredAutomatedSecurityFixesPreview )
return s . client . Do ( ctx , req , nil )
}
2019-05-06 21:12:51 -04:00
// ListContributors lists contributors for a repository.
//
2021-08-10 05:49:43 -04:00
// GitHub API docs: https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#list-repository-contributors
2020-07-31 10:22:34 -04:00
func ( s * RepositoriesService ) ListContributors ( ctx context . Context , owner string , repository string , opts * ListContributorsOptions ) ( [ ] * Contributor , * Response , error ) {
2019-05-06 21:12:51 -04:00
u := fmt . Sprintf ( "repos/%v/%v/contributors" , owner , repository )
2020-07-31 10:22:34 -04:00
u , err := addOptions ( u , opts )
2019-05-06 21:12:51 -04:00
if err != nil {
return nil , nil , err
}
req , err := s . client . NewRequest ( "GET" , u , nil )
if err != nil {
return nil , nil , err
}
var contributor [ ] * Contributor
resp , err := s . client . Do ( ctx , req , & contributor )
if err != nil {
2021-08-10 05:49:43 -04:00
return nil , resp , err
2019-05-06 21:12:51 -04:00
}
return contributor , resp , nil
}
// ListLanguages lists languages for the specified repository. The returned map
// specifies the languages and the number of bytes of code written in that
// language. For example:
//
// {
// "C": 78769,
// "Python": 7769
// }
//
2021-08-10 05:49:43 -04:00
// GitHub API docs: https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#list-repository-languages
2019-05-06 21:12:51 -04:00
func ( s * RepositoriesService ) ListLanguages ( ctx context . Context , owner string , repo string ) ( map [ string ] int , * Response , error ) {
u := fmt . Sprintf ( "repos/%v/%v/languages" , owner , repo )
req , err := s . client . NewRequest ( "GET" , u , nil )
if err != nil {
return nil , nil , err
}
languages := make ( map [ string ] int )
resp , err := s . client . Do ( ctx , req , & languages )
if err != nil {
return nil , resp , err
}
return languages , resp , nil
}
// ListTeams lists the teams for the specified repository.
//
2021-08-10 05:49:43 -04:00
// GitHub API docs: https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#list-repository-teams
2020-07-31 10:22:34 -04:00
func ( s * RepositoriesService ) ListTeams ( ctx context . Context , owner string , repo string , opts * ListOptions ) ( [ ] * Team , * Response , error ) {
2019-05-06 21:12:51 -04:00
u := fmt . Sprintf ( "repos/%v/%v/teams" , owner , repo )
2020-07-31 10:22:34 -04:00
u , err := addOptions ( u , opts )
2019-05-06 21:12:51 -04:00
if err != nil {
return nil , nil , err
}
req , err := s . client . NewRequest ( "GET" , u , nil )
if err != nil {
return nil , nil , err
}
var teams [ ] * Team
resp , err := s . client . Do ( ctx , req , & teams )
if err != nil {
return nil , resp , err
}
return teams , resp , nil
}
// RepositoryTag represents a repository tag.
type RepositoryTag struct {
Name * string ` json:"name,omitempty" `
Commit * Commit ` json:"commit,omitempty" `
ZipballURL * string ` json:"zipball_url,omitempty" `
TarballURL * string ` json:"tarball_url,omitempty" `
}
// ListTags lists tags for the specified repository.
//
2021-08-10 05:49:43 -04:00
// GitHub API docs: https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#list-repository-tags
2020-07-31 10:22:34 -04:00
func ( s * RepositoriesService ) ListTags ( ctx context . Context , owner string , repo string , opts * ListOptions ) ( [ ] * RepositoryTag , * Response , error ) {
2019-05-06 21:12:51 -04:00
u := fmt . Sprintf ( "repos/%v/%v/tags" , owner , repo )
2020-07-31 10:22:34 -04:00
u , err := addOptions ( u , opts )
2019-05-06 21:12:51 -04:00
if err != nil {
return nil , nil , err
}
req , err := s . client . NewRequest ( "GET" , u , nil )
if err != nil {
return nil , nil , err
}
var tags [ ] * RepositoryTag
resp , err := s . client . Do ( ctx , req , & tags )
if err != nil {
return nil , resp , err
}
return tags , resp , nil
}
// Branch represents a repository branch
type Branch struct {
Name * string ` json:"name,omitempty" `
Commit * RepositoryCommit ` json:"commit,omitempty" `
Protected * bool ` json:"protected,omitempty" `
}
// Protection represents a repository branch's protection.
type Protection struct {
2021-08-10 05:49:43 -04:00
RequiredStatusChecks * RequiredStatusChecks ` json:"required_status_checks" `
RequiredPullRequestReviews * PullRequestReviewsEnforcement ` json:"required_pull_request_reviews" `
EnforceAdmins * AdminEnforcement ` json:"enforce_admins" `
Restrictions * BranchRestrictions ` json:"restrictions" `
RequireLinearHistory * RequireLinearHistory ` json:"required_linear_history" `
AllowForcePushes * AllowForcePushes ` json:"allow_force_pushes" `
AllowDeletions * AllowDeletions ` json:"allow_deletions" `
RequiredConversationResolution * RequiredConversationResolution ` json:"required_conversation_resolution" `
2019-05-06 21:12:51 -04:00
}
// ProtectionRequest represents a request to create/edit a branch's protection.
type ProtectionRequest struct {
RequiredStatusChecks * RequiredStatusChecks ` json:"required_status_checks" `
RequiredPullRequestReviews * PullRequestReviewsEnforcementRequest ` json:"required_pull_request_reviews" `
EnforceAdmins bool ` json:"enforce_admins" `
Restrictions * BranchRestrictionsRequest ` json:"restrictions" `
2020-07-31 10:22:34 -04:00
// Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch.
RequireLinearHistory * bool ` json:"required_linear_history,omitempty" `
// Permits force pushes to the protected branch by anyone with write access to the repository.
AllowForcePushes * bool ` json:"allow_force_pushes,omitempty" `
// Allows deletion of the protected branch by anyone with write access to the repository.
AllowDeletions * bool ` json:"allow_deletions,omitempty" `
2019-05-06 21:12:51 -04:00
}
// RequiredStatusChecks represents the protection status of a individual branch.
type RequiredStatusChecks struct {
// Require branches to be up to date before merging. (Required.)
Strict bool ` json:"strict" `
// The list of status checks to require in order to merge into this
// branch. (Required; use []string{} instead of nil for empty list.)
Contexts [ ] string ` json:"contexts" `
}
// RequiredStatusChecksRequest represents a request to edit a protected branch's status checks.
type RequiredStatusChecksRequest struct {
Strict * bool ` json:"strict,omitempty" `
Contexts [ ] string ` json:"contexts,omitempty" `
}
// PullRequestReviewsEnforcement represents the pull request reviews enforcement of a protected branch.
type PullRequestReviewsEnforcement struct {
// Specifies which users and teams can dismiss pull request reviews.
2020-07-31 10:22:34 -04:00
DismissalRestrictions * DismissalRestrictions ` json:"dismissal_restrictions,omitempty" `
2019-05-06 21:12:51 -04:00
// Specifies if approved reviews are dismissed automatically, when a new commit is pushed.
DismissStaleReviews bool ` json:"dismiss_stale_reviews" `
// RequireCodeOwnerReviews specifies if an approved review is required in pull requests including files with a designated code owner.
RequireCodeOwnerReviews bool ` json:"require_code_owner_reviews" `
// RequiredApprovingReviewCount specifies the number of approvals required before the pull request can be merged.
// Valid values are 1-6.
RequiredApprovingReviewCount int ` json:"required_approving_review_count" `
}
// PullRequestReviewsEnforcementRequest represents request to set the pull request review
// enforcement of a protected branch. It is separate from PullRequestReviewsEnforcement above
// because the request structure is different from the response structure.
type PullRequestReviewsEnforcementRequest struct {
// Specifies which users and teams should be allowed to dismiss pull request reviews.
// User and team dismissal restrictions are only available for
// organization-owned repositories. Must be nil for personal repositories.
DismissalRestrictionsRequest * DismissalRestrictionsRequest ` json:"dismissal_restrictions,omitempty" `
// Specifies if approved reviews can be dismissed automatically, when a new commit is pushed. (Required)
DismissStaleReviews bool ` json:"dismiss_stale_reviews" `
// RequireCodeOwnerReviews specifies if an approved review is required in pull requests including files with a designated code owner.
RequireCodeOwnerReviews bool ` json:"require_code_owner_reviews" `
// RequiredApprovingReviewCount specifies the number of approvals required before the pull request can be merged.
// Valid values are 1-6.
RequiredApprovingReviewCount int ` json:"required_approving_review_count" `
}
// PullRequestReviewsEnforcementUpdate represents request to patch the pull request review
// enforcement of a protected branch. It is separate from PullRequestReviewsEnforcementRequest above
// because the patch request does not require all fields to be initialized.
type PullRequestReviewsEnforcementUpdate struct {
// Specifies which users and teams can dismiss pull request reviews. Can be omitted.
DismissalRestrictionsRequest * DismissalRestrictionsRequest ` json:"dismissal_restrictions,omitempty" `
// Specifies if approved reviews can be dismissed automatically, when a new commit is pushed. Can be omitted.
DismissStaleReviews * bool ` json:"dismiss_stale_reviews,omitempty" `
// RequireCodeOwnerReviews specifies if an approved review is required in pull requests including files with a designated code owner.
RequireCodeOwnerReviews bool ` json:"require_code_owner_reviews,omitempty" `
// RequiredApprovingReviewCount specifies the number of approvals required before the pull request can be merged.
// Valid values are 1 - 6.
RequiredApprovingReviewCount int ` json:"required_approving_review_count" `
}
2021-08-10 05:49:43 -04:00
// RequireLinearHistory represents the configuration to enforce branches with no merge commit.
2020-07-31 10:22:34 -04:00
type RequireLinearHistory struct {
Enabled bool ` json:"enabled" `
}
// AllowDeletions represents the configuration to accept deletion of protected branches.
type AllowDeletions struct {
Enabled bool ` json:"enabled" `
}
// AllowForcePushes represents the configuration to accept forced pushes on protected branches.
type AllowForcePushes struct {
Enabled bool ` json:"enabled" `
}
2021-08-10 05:49:43 -04:00
// RequiredConversationResolution, if enabled, requires all comments on the pull request to be resolved before it can be merged to a protected branch.
type RequiredConversationResolution struct {
Enabled bool ` json:"enabled" `
}
2019-05-06 21:12:51 -04:00
// AdminEnforcement represents the configuration to enforce required status checks for repository administrators.
type AdminEnforcement struct {
URL * string ` json:"url,omitempty" `
Enabled bool ` json:"enabled" `
}
// BranchRestrictions represents the restriction that only certain users or
// teams may push to a branch.
type BranchRestrictions struct {
// The list of user logins with push access.
Users [ ] * User ` json:"users" `
// The list of team slugs with push access.
Teams [ ] * Team ` json:"teams" `
2020-07-31 10:22:34 -04:00
// The list of app slugs with push access.
Apps [ ] * App ` json:"apps" `
2019-05-06 21:12:51 -04:00
}
// BranchRestrictionsRequest represents the request to create/edit the
// restriction that only certain users or teams may push to a branch. It is
// separate from BranchRestrictions above because the request structure is
// different from the response structure.
type BranchRestrictionsRequest struct {
// The list of user logins with push access. (Required; use []string{} instead of nil for empty list.)
Users [ ] string ` json:"users" `
// The list of team slugs with push access. (Required; use []string{} instead of nil for empty list.)
Teams [ ] string ` json:"teams" `
2020-07-31 10:22:34 -04:00
// The list of app slugs with push access.
Apps [ ] string ` json:"apps,omitempty" `
2019-05-06 21:12:51 -04:00
}
// DismissalRestrictions specifies which users and teams can dismiss pull request reviews.
type DismissalRestrictions struct {
// The list of users who can dimiss pull request reviews.
Users [ ] * User ` json:"users" `
// The list of teams which can dismiss pull request reviews.
Teams [ ] * Team ` json:"teams" `
}
// DismissalRestrictionsRequest represents the request to create/edit the
// restriction to allows only specific users or teams to dimiss pull request reviews. It is
// separate from DismissalRestrictions above because the request structure is
// different from the response structure.
// Note: Both Users and Teams must be nil, or both must be non-nil.
type DismissalRestrictionsRequest struct {
// The list of user logins who can dismiss pull request reviews. (Required; use nil to disable dismissal_restrictions or &[]string{} otherwise.)
Users * [ ] string ` json:"users,omitempty" `
// The list of team slugs which can dismiss pull request reviews. (Required; use nil to disable dismissal_restrictions or &[]string{} otherwise.)
Teams * [ ] string ` json:"teams,omitempty" `
}
// SignaturesProtectedBranch represents the protection status of an individual branch.
type SignaturesProtectedBranch struct {
URL * string ` json:"url,omitempty" `
// Commits pushed to matching branches must have verified signatures.
Enabled * bool ` json:"enabled,omitempty" `
}
// ListBranches lists branches for the specified repository.
//
2021-08-10 05:49:43 -04:00
// GitHub API docs: https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#list-branches
2020-07-31 10:22:34 -04:00
func ( s * RepositoriesService ) ListBranches ( ctx context . Context , owner string , repo string , opts * BranchListOptions ) ( [ ] * Branch , * Response , error ) {
2019-05-06 21:12:51 -04:00
u := fmt . Sprintf ( "repos/%v/%v/branches" , owner , repo )
2020-07-31 10:22:34 -04:00
u , err := addOptions ( u , opts )
2019-05-06 21:12:51 -04:00
if err != nil {
return nil , nil , err
}
req , err := s . client . NewRequest ( "GET" , u , nil )
if err != nil {
return nil , nil , err
}
var branches [ ] * Branch
resp , err := s . client . Do ( ctx , req , & branches )
if err != nil {
return nil , resp , err
}
return branches , resp , nil
}
// GetBranch gets the specified branch for a repository.
//
2021-08-10 05:49:43 -04:00
// GitHub API docs: https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#get-a-branch
func ( s * RepositoriesService ) GetBranch ( ctx context . Context , owner , repo , branch string , followRedirects bool ) ( * Branch , * Response , error ) {
2019-05-06 21:12:51 -04:00
u := fmt . Sprintf ( "repos/%v/%v/branches/%v" , owner , repo , branch )
2021-08-10 05:49:43 -04:00
resp , err := s . getBranchFromURL ( ctx , u , followRedirects )
2019-05-06 21:12:51 -04:00
if err != nil {
return nil , nil , err
}
2021-08-10 05:49:43 -04:00
defer resp . Body . Close ( )
2019-05-06 21:12:51 -04:00
2021-08-10 05:49:43 -04:00
if resp . StatusCode != http . StatusOK {
return nil , newResponse ( resp ) , fmt . Errorf ( "unexpected status code: %s" , resp . Status )
}
2019-05-06 21:12:51 -04:00
b := new ( Branch )
2021-08-10 05:49:43 -04:00
err = json . NewDecoder ( resp . Body ) . Decode ( b )
return b , newResponse ( resp ) , err
}
func ( s * RepositoriesService ) getBranchFromURL ( ctx context . Context , u string , followRedirects bool ) ( * http . Response , error ) {
req , err := s . client . NewRequest ( "GET" , u , nil )
2019-05-06 21:12:51 -04:00
if err != nil {
2021-08-10 05:49:43 -04:00
return nil , err
}
var resp * http . Response
// Use http.DefaultTransport if no custom Transport is configured
req = withContext ( ctx , req )
if s . client . client . Transport == nil {
resp , err = http . DefaultTransport . RoundTrip ( req )
} else {
resp , err = s . client . client . Transport . RoundTrip ( req )
}
if err != nil {
return nil , err
2019-05-06 21:12:51 -04:00
}
2021-08-10 05:49:43 -04:00
// If redirect response is returned, follow it
if followRedirects && resp . StatusCode == http . StatusMovedPermanently {
resp . Body . Close ( )
u = resp . Header . Get ( "Location" )
resp , err = s . getBranchFromURL ( ctx , u , false )
}
return resp , err
2019-05-06 21:12:51 -04:00
}
// GetBranchProtection gets the protection of a given branch.
//
2021-08-10 05:49:43 -04:00
// GitHub API docs: https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#get-branch-protection
2019-05-06 21:12:51 -04:00
func ( s * RepositoriesService ) GetBranchProtection ( ctx context . Context , owner , repo , branch string ) ( * Protection , * Response , error ) {
u := fmt . Sprintf ( "repos/%v/%v/branches/%v/protection" , owner , repo , branch )
req , err := s . client . NewRequest ( "GET" , u , nil )
if err != nil {
return nil , nil , err
}
// TODO: remove custom Accept header when this API fully launches
req . Header . Set ( "Accept" , mediaTypeRequiredApprovingReviewsPreview )
p := new ( Protection )
resp , err := s . client . Do ( ctx , req , p )
if err != nil {
return nil , resp , err
}
return p , resp , nil
}
// GetRequiredStatusChecks gets the required status checks for a given protected branch.
//
2021-08-10 05:49:43 -04:00
// GitHub API docs: https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#get-status-checks-protection
2019-05-06 21:12:51 -04:00
func ( s * RepositoriesService ) GetRequiredStatusChecks ( ctx context . Context , owner , repo , branch string ) ( * RequiredStatusChecks , * Response , error ) {
u := fmt . Sprintf ( "repos/%v/%v/branches/%v/protection/required_status_checks" , owner , repo , branch )
req , err := s . client . NewRequest ( "GET" , u , nil )
if err != nil {
return nil , nil , err
}
p := new ( RequiredStatusChecks )
resp , err := s . client . Do ( ctx , req , p )
if err != nil {
return nil , resp , err
}
return p , resp , nil
}
// ListRequiredStatusChecksContexts lists the required status checks contexts for a given protected branch.
//
2021-08-10 05:49:43 -04:00
// GitHub API docs: https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#get-all-status-check-contexts
2019-05-06 21:12:51 -04:00
func ( s * RepositoriesService ) ListRequiredStatusChecksContexts ( ctx context . Context , owner , repo , branch string ) ( contexts [ ] string , resp * Response , err error ) {
u := fmt . Sprintf ( "repos/%v/%v/branches/%v/protection/required_status_checks/contexts" , owner , repo , branch )
req , err := s . client . NewRequest ( "GET" , u , nil )
if err != nil {
return nil , nil , err
}
resp , err = s . client . Do ( ctx , req , & contexts )
if err != nil {
return nil , resp , err
}
return contexts , resp , nil
}
// UpdateBranchProtection updates the protection of a given branch.
//
2021-08-10 05:49:43 -04:00
// GitHub API docs: https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#update-branch-protection
2019-05-06 21:12:51 -04:00
func ( s * RepositoriesService ) UpdateBranchProtection ( ctx context . Context , owner , repo , branch string , preq * ProtectionRequest ) ( * Protection , * Response , error ) {
u := fmt . Sprintf ( "repos/%v/%v/branches/%v/protection" , owner , repo , branch )
req , err := s . client . NewRequest ( "PUT" , u , preq )
if err != nil {
return nil , nil , err
}
// TODO: remove custom Accept header when this API fully launches
req . Header . Set ( "Accept" , mediaTypeRequiredApprovingReviewsPreview )
p := new ( Protection )
resp , err := s . client . Do ( ctx , req , p )
if err != nil {
return nil , resp , err
}
return p , resp , nil
}
// RemoveBranchProtection removes the protection of a given branch.
//
2021-08-10 05:49:43 -04:00
// GitHub API docs: https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#delete-branch-protection
2019-05-06 21:12:51 -04:00
func ( s * RepositoriesService ) RemoveBranchProtection ( ctx context . Context , owner , repo , branch string ) ( * Response , error ) {
u := fmt . Sprintf ( "repos/%v/%v/branches/%v/protection" , owner , repo , branch )
req , err := s . client . NewRequest ( "DELETE" , u , nil )
if err != nil {
return nil , err
}
return s . client . Do ( ctx , req , nil )
}
// GetSignaturesProtectedBranch gets required signatures of protected branch.
//
2021-08-10 05:49:43 -04:00
// GitHub API docs: https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#get-commit-signature-protection
2019-05-06 21:12:51 -04:00
func ( s * RepositoriesService ) GetSignaturesProtectedBranch ( ctx context . Context , owner , repo , branch string ) ( * SignaturesProtectedBranch , * Response , error ) {
u := fmt . Sprintf ( "repos/%v/%v/branches/%v/protection/required_signatures" , owner , repo , branch )
req , err := s . client . NewRequest ( "GET" , u , nil )
if err != nil {
return nil , nil , err
}
// TODO: remove custom Accept header when this API fully launches
req . Header . Set ( "Accept" , mediaTypeSignaturePreview )
p := new ( SignaturesProtectedBranch )
resp , err := s . client . Do ( ctx , req , p )
if err != nil {
return nil , resp , err
}
return p , resp , nil
}
// RequireSignaturesOnProtectedBranch makes signed commits required on a protected branch.
// It requires admin access and branch protection to be enabled.
//
2021-08-10 05:49:43 -04:00
// GitHub API docs: https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#create-commit-signature-protection
2019-05-06 21:12:51 -04:00
func ( s * RepositoriesService ) RequireSignaturesOnProtectedBranch ( ctx context . Context , owner , repo , branch string ) ( * SignaturesProtectedBranch , * Response , error ) {
u := fmt . Sprintf ( "repos/%v/%v/branches/%v/protection/required_signatures" , owner , repo , branch )
req , err := s . client . NewRequest ( "POST" , u , nil )
if err != nil {
return nil , nil , err
}
// TODO: remove custom Accept header when this API fully launches
req . Header . Set ( "Accept" , mediaTypeSignaturePreview )
r := new ( SignaturesProtectedBranch )
resp , err := s . client . Do ( ctx , req , r )
if err != nil {
return nil , resp , err
}
return r , resp , err
}
// OptionalSignaturesOnProtectedBranch removes required signed commits on a given branch.
//
2021-08-10 05:49:43 -04:00
// GitHub API docs: https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#delete-commit-signature-protection
2019-05-06 21:12:51 -04:00
func ( s * RepositoriesService ) OptionalSignaturesOnProtectedBranch ( ctx context . Context , owner , repo , branch string ) ( * Response , error ) {
u := fmt . Sprintf ( "repos/%v/%v/branches/%v/protection/required_signatures" , owner , repo , branch )
req , err := s . client . NewRequest ( "DELETE" , u , nil )
if err != nil {
return nil , err
}
// TODO: remove custom Accept header when this API fully launches
req . Header . Set ( "Accept" , mediaTypeSignaturePreview )
return s . client . Do ( ctx , req , nil )
}
// UpdateRequiredStatusChecks updates the required status checks for a given protected branch.
//
2021-08-10 05:49:43 -04:00
// GitHub API docs: https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#update-status-check-protection
2019-05-06 21:12:51 -04:00
func ( s * RepositoriesService ) UpdateRequiredStatusChecks ( ctx context . Context , owner , repo , branch string , sreq * RequiredStatusChecksRequest ) ( * RequiredStatusChecks , * Response , error ) {
u := fmt . Sprintf ( "repos/%v/%v/branches/%v/protection/required_status_checks" , owner , repo , branch )
req , err := s . client . NewRequest ( "PATCH" , u , sreq )
if err != nil {
return nil , nil , err
}
sc := new ( RequiredStatusChecks )
resp , err := s . client . Do ( ctx , req , sc )
if err != nil {
return nil , resp , err
}
return sc , resp , nil
}
2021-08-10 05:49:43 -04:00
// RemoveRequiredStatusChecks removes the required status checks for a given protected branch.
//
// GitHub API docs: https://docs.github.com/en/free-pro-team@latest/rest/reference/repos#remove-status-check-protection
func ( s * RepositoriesService ) RemoveRequiredStatusChecks ( ctx context . Context , owner , repo , branch string ) ( * Response , error ) {
u := fmt . Sprintf ( "repos/%v/%v/branches/%v/protection/required_status_checks" , owner , repo , branch )
req , err := s . client . NewRequest ( "DELETE" , u , nil )
if err != nil {
return nil , err
}
return s . client . Do ( ctx , req , nil )
}
2019-05-06 21:12:51 -04:00
// License gets the contents of a repository's license if one is detected.
//
2021-08-10 05:49:43 -04:00
// GitHub API docs: https://docs.github.com/en/free-pro-team@latest/rest/reference/licenses/#get-the-license-for-a-repository
2019-05-06 21:12:51 -04:00
func ( s * RepositoriesService ) License ( ctx context . Context , owner , repo string ) ( * RepositoryLicense , * Response , error ) {
u := fmt . Sprintf ( "repos/%v/%v/license" , owner , repo )
req , err := s . client . NewRequest ( "GET" , u , nil )
if err != nil {
return nil , nil , err
}
r := & RepositoryLicense { }
resp , err := s . client . Do ( ctx , req , r )
if err != nil {
return nil , resp , err
}
return r , resp , nil
}
// GetPullRequestReviewEnforcement gets pull request review enforcement of a protected branch.
//
2021-08-10 05:49:43 -04:00
// GitHub API docs: https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#get-pull-request-review-protection
2019-05-06 21:12:51 -04:00
func ( s * RepositoriesService ) GetPullRequestReviewEnforcement ( ctx context . Context , owner , repo , branch string ) ( * PullRequestReviewsEnforcement , * Response , error ) {
u := fmt . Sprintf ( "repos/%v/%v/branches/%v/protection/required_pull_request_reviews" , owner , repo , branch )
req , err := s . client . NewRequest ( "GET" , u , nil )
if err != nil {
return nil , nil , err
}
// TODO: remove custom Accept header when this API fully launches
req . Header . Set ( "Accept" , mediaTypeRequiredApprovingReviewsPreview )
r := new ( PullRequestReviewsEnforcement )
resp , err := s . client . Do ( ctx , req , r )
if err != nil {
return nil , resp , err
}
return r , resp , nil
}
// UpdatePullRequestReviewEnforcement patches pull request review enforcement of a protected branch.
// It requires admin access and branch protection to be enabled.
//
2021-08-10 05:49:43 -04:00
// GitHub API docs: https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#update-pull-request-review-protection
2019-05-06 21:12:51 -04:00
func ( s * RepositoriesService ) UpdatePullRequestReviewEnforcement ( ctx context . Context , owner , repo , branch string , patch * PullRequestReviewsEnforcementUpdate ) ( * PullRequestReviewsEnforcement , * Response , error ) {
u := fmt . Sprintf ( "repos/%v/%v/branches/%v/protection/required_pull_request_reviews" , owner , repo , branch )
req , err := s . client . NewRequest ( "PATCH" , u , patch )
if err != nil {
return nil , nil , err
}
// TODO: remove custom Accept header when this API fully launches
req . Header . Set ( "Accept" , mediaTypeRequiredApprovingReviewsPreview )
r := new ( PullRequestReviewsEnforcement )
resp , err := s . client . Do ( ctx , req , r )
if err != nil {
return nil , resp , err
}
return r , resp , err
}
// DisableDismissalRestrictions disables dismissal restrictions of a protected branch.
// It requires admin access and branch protection to be enabled.
//
2021-08-10 05:49:43 -04:00
// GitHub API docs: https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#update-pull-request-review-protection
2019-05-06 21:12:51 -04:00
func ( s * RepositoriesService ) DisableDismissalRestrictions ( ctx context . Context , owner , repo , branch string ) ( * PullRequestReviewsEnforcement , * Response , error ) {
u := fmt . Sprintf ( "repos/%v/%v/branches/%v/protection/required_pull_request_reviews" , owner , repo , branch )
2020-07-31 10:22:34 -04:00
data := new ( struct {
DismissalRestrictionsRequest ` json:"dismissal_restrictions" `
} )
2019-05-06 21:12:51 -04:00
req , err := s . client . NewRequest ( "PATCH" , u , data )
if err != nil {
return nil , nil , err
}
// TODO: remove custom Accept header when this API fully launches
req . Header . Set ( "Accept" , mediaTypeRequiredApprovingReviewsPreview )
r := new ( PullRequestReviewsEnforcement )
resp , err := s . client . Do ( ctx , req , r )
if err != nil {
return nil , resp , err
}
return r , resp , err
}
// RemovePullRequestReviewEnforcement removes pull request enforcement of a protected branch.
//
2021-08-10 05:49:43 -04:00
// GitHub API docs: https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#delete-pull-request-review-protection
2019-05-06 21:12:51 -04:00
func ( s * RepositoriesService ) RemovePullRequestReviewEnforcement ( ctx context . Context , owner , repo , branch string ) ( * Response , error ) {
u := fmt . Sprintf ( "repos/%v/%v/branches/%v/protection/required_pull_request_reviews" , owner , repo , branch )
req , err := s . client . NewRequest ( "DELETE" , u , nil )
if err != nil {
return nil , err
}
return s . client . Do ( ctx , req , nil )
}
// GetAdminEnforcement gets admin enforcement information of a protected branch.
//
2021-08-10 05:49:43 -04:00
// GitHub API docs: https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#get-admin-branch-protection
2019-05-06 21:12:51 -04:00
func ( s * RepositoriesService ) GetAdminEnforcement ( ctx context . Context , owner , repo , branch string ) ( * AdminEnforcement , * Response , error ) {
u := fmt . Sprintf ( "repos/%v/%v/branches/%v/protection/enforce_admins" , owner , repo , branch )
req , err := s . client . NewRequest ( "GET" , u , nil )
if err != nil {
return nil , nil , err
}
r := new ( AdminEnforcement )
resp , err := s . client . Do ( ctx , req , r )
if err != nil {
return nil , resp , err
}
return r , resp , nil
}
// AddAdminEnforcement adds admin enforcement to a protected branch.
// It requires admin access and branch protection to be enabled.
//
2021-08-10 05:49:43 -04:00
// GitHub API docs: https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#set-admin-branch-protection
2019-05-06 21:12:51 -04:00
func ( s * RepositoriesService ) AddAdminEnforcement ( ctx context . Context , owner , repo , branch string ) ( * AdminEnforcement , * Response , error ) {
u := fmt . Sprintf ( "repos/%v/%v/branches/%v/protection/enforce_admins" , owner , repo , branch )
req , err := s . client . NewRequest ( "POST" , u , nil )
if err != nil {
return nil , nil , err
}
r := new ( AdminEnforcement )
resp , err := s . client . Do ( ctx , req , r )
if err != nil {
return nil , resp , err
}
return r , resp , err
}
// RemoveAdminEnforcement removes admin enforcement from a protected branch.
//
2021-08-10 05:49:43 -04:00
// GitHub API docs: https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#delete-admin-branch-protection
2019-05-06 21:12:51 -04:00
func ( s * RepositoriesService ) RemoveAdminEnforcement ( ctx context . Context , owner , repo , branch string ) ( * Response , error ) {
u := fmt . Sprintf ( "repos/%v/%v/branches/%v/protection/enforce_admins" , owner , repo , branch )
req , err := s . client . NewRequest ( "DELETE" , u , nil )
if err != nil {
return nil , err
}
return s . client . Do ( ctx , req , nil )
}
// repositoryTopics represents a collection of repository topics.
type repositoryTopics struct {
Names [ ] string ` json:"names" `
}
// ListAllTopics lists topics for a repository.
//
2021-08-10 05:49:43 -04:00
// GitHub API docs: https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#get-all-repository-topics
2019-05-06 21:12:51 -04:00
func ( s * RepositoriesService ) ListAllTopics ( ctx context . Context , owner , repo string ) ( [ ] string , * Response , error ) {
u := fmt . Sprintf ( "repos/%v/%v/topics" , owner , repo )
req , err := s . client . NewRequest ( "GET" , u , nil )
if err != nil {
return nil , nil , err
}
// TODO: remove custom Accept header when this API fully launches.
req . Header . Set ( "Accept" , mediaTypeTopicsPreview )
topics := new ( repositoryTopics )
resp , err := s . client . Do ( ctx , req , topics )
if err != nil {
return nil , resp , err
}
return topics . Names , resp , nil
}
// ReplaceAllTopics replaces topics for a repository.
//
2021-08-10 05:49:43 -04:00
// GitHub API docs: https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#replace-all-repository-topics
2019-05-06 21:12:51 -04:00
func ( s * RepositoriesService ) ReplaceAllTopics ( ctx context . Context , owner , repo string , topics [ ] string ) ( [ ] string , * Response , error ) {
u := fmt . Sprintf ( "repos/%v/%v/topics" , owner , repo )
t := & repositoryTopics {
Names : topics ,
}
if t . Names == nil {
t . Names = [ ] string { }
}
req , err := s . client . NewRequest ( "PUT" , u , t )
if err != nil {
return nil , nil , err
}
// TODO: remove custom Accept header when this API fully launches.
req . Header . Set ( "Accept" , mediaTypeTopicsPreview )
t = new ( repositoryTopics )
resp , err := s . client . Do ( ctx , req , t )
if err != nil {
return nil , resp , err
}
return t . Names , resp , nil
}
2021-08-10 05:49:43 -04:00
// ListApps lists the GitHub apps that have push access to a given protected branch.
// It requires the GitHub apps to have `write` access to the `content` permission.
2020-07-31 10:22:34 -04:00
//
2021-08-10 05:49:43 -04:00
// GitHub API docs: https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#get-apps-with-access-to-the-protected-branch
2020-07-31 10:22:34 -04:00
func ( s * RepositoriesService ) ListApps ( ctx context . Context , owner , repo , branch string ) ( [ ] * App , * Response , error ) {
u := fmt . Sprintf ( "repos/%v/%v/branches/%v/protection/restrictions/apps" , owner , repo , branch )
req , err := s . client . NewRequest ( "GET" , u , nil )
if err != nil {
return nil , nil , err
}
var apps [ ] * App
resp , err := s . client . Do ( ctx , req , & apps )
if err != nil {
return nil , resp , err
}
return apps , resp , nil
}
// ReplaceAppRestrictions replaces the apps that have push access to a given protected branch.
// It removes all apps that previously had push access and grants push access to the new list of apps.
2021-08-10 05:49:43 -04:00
// It requires the GitHub apps to have `write` access to the `content` permission.
2020-07-31 10:22:34 -04:00
//
// Note: The list of users, apps, and teams in total is limited to 100 items.
//
2021-08-10 05:49:43 -04:00
// GitHub API docs: https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#set-app-access-restrictions
2020-07-31 10:22:34 -04:00
func ( s * RepositoriesService ) ReplaceAppRestrictions ( ctx context . Context , owner , repo , branch string , slug [ ] string ) ( [ ] * App , * Response , error ) {
u := fmt . Sprintf ( "repos/%v/%v/branches/%v/protection/restrictions/apps" , owner , repo , branch )
req , err := s . client . NewRequest ( "PUT" , u , slug )
if err != nil {
return nil , nil , err
}
var apps [ ] * App
resp , err := s . client . Do ( ctx , req , & apps )
if err != nil {
2021-08-10 05:49:43 -04:00
return nil , resp , err
2020-07-31 10:22:34 -04:00
}
return apps , resp , nil
}
// AddAppRestrictions grants the specified apps push access to a given protected branch.
2021-08-10 05:49:43 -04:00
// It requires the GitHub apps to have `write` access to the `content` permission.
2020-07-31 10:22:34 -04:00
//
// Note: The list of users, apps, and teams in total is limited to 100 items.
//
2021-08-10 05:49:43 -04:00
// GitHub API docs: https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#add-app-access-restrictions
2020-07-31 10:22:34 -04:00
func ( s * RepositoriesService ) AddAppRestrictions ( ctx context . Context , owner , repo , branch string , slug [ ] string ) ( [ ] * App , * Response , error ) {
u := fmt . Sprintf ( "repos/%v/%v/branches/%v/protection/restrictions/apps" , owner , repo , branch )
req , err := s . client . NewRequest ( "POST" , u , slug )
if err != nil {
return nil , nil , err
}
var apps [ ] * App
resp , err := s . client . Do ( ctx , req , & apps )
if err != nil {
2021-08-10 05:49:43 -04:00
return nil , resp , err
2020-07-31 10:22:34 -04:00
}
return apps , resp , nil
}
// RemoveAppRestrictions removes the ability of an app to push to this branch.
2021-08-10 05:49:43 -04:00
// It requires the GitHub apps to have `write` access to the `content` permission.
2020-07-31 10:22:34 -04:00
//
// Note: The list of users, apps, and teams in total is limited to 100 items.
//
2021-08-10 05:49:43 -04:00
// GitHub API docs: https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#remove-app-access-restrictions
2020-07-31 10:22:34 -04:00
func ( s * RepositoriesService ) RemoveAppRestrictions ( ctx context . Context , owner , repo , branch string , slug [ ] string ) ( [ ] * App , * Response , error ) {
u := fmt . Sprintf ( "repos/%v/%v/branches/%v/protection/restrictions/apps" , owner , repo , branch )
req , err := s . client . NewRequest ( "DELETE" , u , slug )
if err != nil {
return nil , nil , err
}
var apps [ ] * App
resp , err := s . client . Do ( ctx , req , & apps )
if err != nil {
2021-08-10 05:49:43 -04:00
return nil , resp , err
2020-07-31 10:22:34 -04:00
}
return apps , resp , nil
}
2019-05-06 21:12:51 -04:00
// TransferRequest represents a request to transfer a repository.
type TransferRequest struct {
NewOwner string ` json:"new_owner" `
TeamID [ ] int64 ` json:"team_ids,omitempty" `
}
// Transfer transfers a repository from one account or organization to another.
//
// This method might return an *AcceptedError and a status code of
// 202. This is because this is the status that GitHub returns to signify that
// it has now scheduled the transfer of the repository in a background task.
// A follow up request, after a delay of a second or so, should result
// in a successful request.
//
2021-08-10 05:49:43 -04:00
// GitHub API docs: https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#transfer-a-repository
2019-05-06 21:12:51 -04:00
func ( s * RepositoriesService ) Transfer ( ctx context . Context , owner , repo string , transfer TransferRequest ) ( * Repository , * Response , error ) {
u := fmt . Sprintf ( "repos/%v/%v/transfer" , owner , repo )
req , err := s . client . NewRequest ( "POST" , u , & transfer )
if err != nil {
return nil , nil , err
}
2020-07-31 10:22:34 -04:00
r := new ( Repository )
resp , err := s . client . Do ( ctx , req , r )
if err != nil {
return nil , resp , err
}
return r , resp , nil
}
// DispatchRequestOptions represents a request to trigger a repository_dispatch event.
type DispatchRequestOptions struct {
// EventType is a custom webhook event name. (Required.)
EventType string ` json:"event_type" `
// ClientPayload is a custom JSON payload with extra information about the webhook event.
// Defaults to an empty JSON object.
ClientPayload * json . RawMessage ` json:"client_payload,omitempty" `
}
// Dispatch triggers a repository_dispatch event in a GitHub Actions workflow.
//
2021-08-10 05:49:43 -04:00
// GitHub API docs: https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#create-a-repository-dispatch-event
2020-07-31 10:22:34 -04:00
func ( s * RepositoriesService ) Dispatch ( ctx context . Context , owner , repo string , opts DispatchRequestOptions ) ( * Repository , * Response , error ) {
u := fmt . Sprintf ( "repos/%v/%v/dispatches" , owner , repo )
req , err := s . client . NewRequest ( "POST" , u , & opts )
if err != nil {
return nil , nil , err
}
2019-05-06 21:12:51 -04:00
r := new ( Repository )
resp , err := s . client . Do ( ctx , req , r )
if err != nil {
return nil , resp , err
}
return r , resp , nil
}