filebrowser

Documentation

Index

• func GetMainAndCurrentBranchRefs(scmClient scmProviderClient, fullName, eventRef string) ([]string, error)
• type Interface
  • func NewFileBrowserFromGitClient(clientFactory git.ClientFactory) Interface
  • func NewFileBrowserFromScmClient(scmClient scmProviderClient) Interface

Functions

func GetMainAndCurrentBranchRefs

func GetMainAndCurrentBranchRefs(scmClient scmProviderClient, fullName, eventRef string) ([]string, error)

GetMainAndCurrentBranchRefs a function to return the main branch then the eventRef

Types

type Interface

type Interface interface {
	// GetMainAndCurrentBranchRefs returns the main branch then the ref value if its different
	GetMainAndCurrentBranchRefs(owner, repo, ref string) ([]string, error)

	// GetFile returns a file from the given path in the repository with the given sha
	GetFile(owner, repo, path, ref string) ([]byte, error)

	// ListFiles returns the file and directory entries in the given path in the repository with the given sha
	ListFiles(owner, repo, path, ref string) ([]*scm.FileEntry, error)
}

Interface an interface to represent browsing files in a repository

func NewFileBrowserFromGitClient

func NewFileBrowserFromGitClient(clientFactory git.ClientFactory) Interface

NewFileBrowserFromGitClient creates a new file browser from an Scm client

func NewFileBrowserFromScmClient

func NewFileBrowserFromScmClient(scmClient scmProviderClient) Interface

NewFileBrowserFromScmClient creates a new file browser from an Scm client