repo

Documentation

Index

• type GitHubAuth
• type Repository
  • func GitHub(path string, githubAuth *GitHubAuth) (*Repository, error)
  • func Golang(url string) (*Repository, error)
  • func Honnef(url string) (*Repository, error)
  • func Info(path string, gitHubAuth *GitHubAuth) (*Repository, error)

Types

type GitHubAuth

type GitHubAuth struct {
	// Username is a GitHub username.
	Username string
	// Token is a GitHub access token.
	Token string
}

GitHubAuth represents authentication data for the GitHub API.

type Repository

type Repository struct {
	// Maintainer is the full name of the repository owner, or
	// username if the real name is unknown.
	Maintainer string
	// URL is the HTML URL of a repository that can be viewed in a
	// webbrowser.
	URL string
}

Repository describes GitHub repository metadata

func GitHub

func GitHub(path string, githubAuth *GitHubAuth) (*Repository, error)

Repo fetches basic metadata of a GitHub repository identified by its import paths. Import paths that are not recognizable GitHub repositories return an error.

func Golang

func Golang(url string) (*Repository, error)

func Honnef

func Honnef(url string) (*Repository, error)

func Info

func Info(path string, gitHubAuth *GitHubAuth) (*Repository, error)

Info returns information about source code repositories based on the import path. Only a few common paths are currently supported.