githubapi

Documentation

Overview

Package githubapi contains functionality related to the GitHub API

Index

• 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)

Functions

func CreateOrUpdatePullRequest

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

func GetGitHubClient(accessToken string) *github.Client

GetGitHubClient returns a GitHub client for API calls

func GetRepoFileList

func GetRepoFileList(client *github.Client, org string, repo string, defaultBranch string) []string

GetRepoFileList returns a list (strings) of all files in a repo, including their path.

func GetRepository

func GetRepository(client *github.Client, org string, repo string) (*github.Repository, error)

GetRepository gets a repository object.