git

Documentation

Index

• func CloneRepository(url, destination, branch string) (*git.Repository, error)
• func GetCommitStats(repo *git.Repository) (int, error)
• type Contributor
• type RepositoryData
  • func GetRepositoryData(repo *git.Repository, owner, name, repoPath string) (*RepositoryData, error)

Functions

func CloneRepository

func CloneRepository(url, destination, branch string) (*git.Repository, error)

CloneRepository clones a Git repository to the specified directory

func GetCommitStats

func GetCommitStats(repo *git.Repository) (int, error)

GetCommitStats gets commit statistics for the repository

Types

type Contributor

type Contributor struct {
	Name      string
	Email     string
	Commits   int
	AvatarURL string
}

Contributor represents a repository contributor

type RepositoryData

type RepositoryData struct {
	Owner       string
	Name        string
	Description string
	URL         string

	// Content
	ReadmeContent string
	ReadmePath    string
	MarkdownFiles map[string]string // path -> content

	// Stats from git
	Contributors   []Contributor
	CommitCount    int
	LastCommitDate time.Time

	// License information if available
	License string

	// Set of image paths in the repository (to copy to output)
	ImageFiles map[string]string // path -> full path on disk
}

RepositoryData contains all the information about a repository

func GetRepositoryData

func GetRepositoryData(repo *git.Repository, owner, name, repoPath string) (*RepositoryData, error)

GetRepositoryData extracts information from a cloned repository