core

Documentation

Index

• Variables
• func AutoselectDefaultBranch(repo *git.Repository) error
• func GetDefaultBranch(repo *git.Repository) (plumbing.ReferenceName, error)
• func GetHEAD(repo *git.Repository) (*plumbing.Reference, error)
• func GetReadmeContent(repo *git.Repository) ([]byte, error)
• func GetRenderedReadmeContent(repo *git.Repository) (string, error)
• func IsRepositoryEmpty(repo *git.Repository) (bool, error)
• func SetDefaultBranch(repo *git.Repository, ref plumbing.ReferenceName) error
• func ValidateRepositoryName(repoNameSlug string) error
• func ValidateSlug(input string) bool
• type RepoOnDisk
  • func CreateRepository(name string) (*RepoOnDisk, error)
  • func GetRepository(slug string) (*RepoOnDisk, error)
  • func ListRepositories() ([]*RepoOnDisk, error)
  • func (r *RepoOnDisk) Size() (int64, error)

Variables

var ErrNoReadme = errors.New("no README.md file found")

Functions

func AutoselectDefaultBranch

func AutoselectDefaultBranch(repo *git.Repository) error

func GetDefaultBranch

func GetDefaultBranch(repo *git.Repository) (plumbing.ReferenceName, error)

func GetHEAD

func GetHEAD(repo *git.Repository) (*plumbing.Reference, error)

func GetReadmeContent

func GetReadmeContent(repo *git.Repository) ([]byte, error)

GetReadmeContent returns the raw Markdown of a README.md file

func GetRenderedReadmeContent

func GetRenderedReadmeContent(repo *git.Repository) (string, error)

func IsRepositoryEmpty

func IsRepositoryEmpty(repo *git.Repository) (bool, error)

func SetDefaultBranch

func SetDefaultBranch(repo *git.Repository, ref plumbing.ReferenceName) error

func ValidateRepositoryName

func ValidateRepositoryName(repoNameSlug string) error

func ValidateSlug

func ValidateSlug(input string) bool

Types

type RepoOnDisk

type RepoOnDisk struct {
	Slug        string
	Description string

	Path string
}

func CreateRepository

func CreateRepository(name string) (*RepoOnDisk, error)

func GetRepository

func GetRepository(slug string) (*RepoOnDisk, error)

func ListRepositories

func ListRepositories() ([]*RepoOnDisk, error)

ListRepositories returns the list of repositories in a given directory.

It assumes that any directory is a repository.

func (*RepoOnDisk) Size

func (r *RepoOnDisk) Size() (int64, error)