Documentation
¶
Overview ¶
Package githubapi contains functionality related to the GitHub API
Index ¶
- func CheckDirectoryExists(client *github.Client, org string, repo string, directory string, ...) (bool, error)
- func CheckRateLimit(client *github.Client, minRemaining int) (bool, int, error)
- func CreateOrUpdatePullRequest(client *github.Client, org string, repo string, baseBranch string, ...) error
- func CreatePRDescription(changeInfo config.ChangeInfo) string
- func GetFileContent(client *github.Client, org string, repo string, path string, branchName string) ([]byte, error)
- func GetGitHubClient(accessToken string) *github.Client
- func GetRepoFileList(client *github.Client, org string, repo string, defaultBranch string) []string
- func GetRepository(client *github.Client, org string, repo string) (*github.Repository, error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CheckDirectoryExists ¶ added in v0.7.0
func CheckDirectoryExists(client *github.Client, org string, repo string, directory string, branchName string) (bool, error)
CheckDirectoryExists checks if a directory exists in the remote GitHub repository.
func CheckRateLimit ¶ added in v0.8.3
CheckRateLimit checks if there are enough GitHub API requests remaining.
func CreateOrUpdatePullRequest ¶ added in v0.3.0
func CreateOrUpdatePullRequest(client *github.Client, org string, repo string, baseBranch string, prDesc string, content string, toolConfig config.ToolConfig) error
CreateOrUpdatePullRequest creates or updates a PR for changes in dependabot.yml
func CreatePRDescription ¶
func CreatePRDescription(changeInfo config.ChangeInfo) string
CreatePRDescription renders the body of the PR to be created.
func GetFileContent ¶
func GetFileContent(client *github.Client, org string, repo string, path string, branchName string) ([]byte, error)
GetFileContent returns the content of a file
func GetGitHubClient ¶
GetGitHubClient returns a GitHub client for API calls
func GetRepoFileList ¶
GetRepoFileList returns a list (strings) of all files in a repo, including their path.
func GetRepository ¶
GetRepository gets a repository object.
Types ¶
This section is empty.
Source Files
Click to show internal directories.
Click to hide internal directories.