githubutil

Nov 4, 2025

Changes in this version

+ var ErrNoAuthProvided = errors.New("no GitHub authentication provided")

+ var NewJWTTokenDebugLogger *log.Logger = log.New(io.Discard, "", 0)

+ func CreateBranch(ctx context.Context, client *github.Client, ...) error

+ func ListDirFiles(ctx context.Context, client *github.Client, owner, repo, ref, dir string) ([]*github.RepositoryContent, error)

+ type FS struct

+ func NewRefFS(ctx context.Context, client *github.Client, owner, repo, ref string) *FS

+ func (r *FS) ReadDir(name string) ([]fs.DirEntry, error)

+ func (r *FS) ReadFile(name string) ([]byte, error)

+ type FSDirEntry struct

+ func (r *FSDirEntry) Info() (fs.FileInfo, error)

+ func (r *FSDirEntry) IsDir() bool

+ func (r *FSDirEntry) ModTime() time.Time

+ func (r *FSDirEntry) Mode() fs.FileMode

+ func (r *FSDirEntry) Name() string

+ func (r *FSDirEntry) Size() int64

+ func (r *FSDirEntry) Sys() any

+ func (r *FSDirEntry) Type() fs.FileMode

+ type GitHubAPIAuther interface

+ GetIdentity func() (string, error)

+ type GitHubAppAuther struct

+ ClientID string

+ InstallationID int64

+ PrivateKey string

+ func (a GitHubAppAuther) GetIdentity() (string, error)

+ func (a GitHubAppAuther) InsertAuth(url string) string

+ func (a GitHubAppAuther) InsertHTTPAuth(req *http.Request) error

+ type GitHubAuthFlags struct

+ GitHubAppClientID *string

+ GitHubAppInstallation *int64

+ GitHubAppPrivateKey *string

+ GitHubPat *string

+ func BindGitHubAuthFlags(user string) *GitHubAuthFlags

+ func (f *GitHubAuthFlags) NewAppClient(ctx context.Context) (*github.Client, error)

+ func (f *GitHubAuthFlags) NewAuther() (GitHubAPIAuther, error)

+ func (f *GitHubAuthFlags) NewClient(ctx context.Context) (*github.Client, error)

+ type GitHubPATAuther struct

+ PAT string

+ User string

+ func (a GitHubPATAuther) GetIdentity() (string, error)

+ func (a GitHubPATAuther) InsertAuth(url string) string

+ func (a GitHubPATAuther) InsertHTTPAuth(req *http.Request) error

+ type GitHubSSHAuther struct

+ func (GitHubSSHAuther) InsertAuth(url string) string

+ type HTTPRequestAuther interface

+ InsertHTTPAuth func(req *http.Request) error

+ type SimplifiedFS interface

+ ReadDir func(name string) ([]fs.DirEntry, error)

+ ReadFile func(name string) ([]byte, error)

Dec 16, 2024

Changes in this version

+ const TreeModeDir

+ const TreeModeExecutable

+ const TreeModeFile

+ const TreeModeGitlink

+ const TreeModeSubmodule

+ var ErrFileNotExists = errors.New("file does not exist in the given repository and branch")

+ var ErrRepositoryNotExists = errors.New("repository does not exist")

+ func FetchRepository(ctx context.Context, client *github.Client, owner, repo string) (*github.Repository, error)

+ func FullyCreateFork(ctx context.Context, client *github.Client, upstreamOwner, repo string) (*github.Repository, error)

+ func PATScopes(ctx context.Context, client *github.Client) ([]string, error)

Jul 17, 2024

Changes in this version

+ var ErrNotExists = errors.New("file does not exist in the given repository and branch")

+ func DownloadFile(ctx context.Context, client *github.Client, owner, repo, branch, path string) ([]byte, error)

Jul 10, 2024

Changes in this version

+ func FileExists(ctx context.Context, client *github.Client, owner, repo, filePath string) (bool, error)

+ func UploadFile(ctx context.Context, client *github.Client, ...) error

Apr 10, 2024

Changes in this version

+ func BindPATFlag() *string

+ func BindRepoFlag() *string

+ func FetchEachPage(f func(options github.ListOptions) (*github.Response, error)) error

+ func NewClient(ctx context.Context, pat string) (*github.Client, error)

+ func ParseRepoFlag(repo *string) (owner, name string, err error)

+ func Retry(f func() error) error