package repos

import "golang.org/x/build/repos"

Package repos contains information about Go source repositories.

Index ¶

• Variables
• type Repo
• func (r *Repo) GitHubRepo() string
• func (r *Repo) ShowOnDashboard() bool
• func (r *Repo) UsePkgGoDev() bool

Package Files ¶

repos.go

Variables ¶

var ByGerritProject = map[string]*Repo{}

ByGerritProject maps from a Gerrit project name ("go", "net", etc) to the Repo's information.

var ByImportPath = map[string]*Repo{}

ByImportPath maps from an import path ("golang.org/x/net") to the Repo's information.

type Repo ¶ Uses

type Repo struct {
    // GoGerritProject, if non-empty, is the repo's Gerrit project
    // name, such as "go", "net", or "sys".
    GoGerritProject string

    // ImportPath is the repo's import path.
    // It is empty for the main Go repo and other repos that do not
    // contain Go code.
    ImportPath string

    // MirrorToGitHub controls whether this repo is mirrored
    // from Gerrit to GitHub. If true, GoGerritProject and
    // gitHubRepo must both be defined.
    MirrorToGitHub bool

    // CoordinatorCanBuild reports whether this a repo that the
    // build coordinator knows how to build.
    CoordinatorCanBuild bool

    // WebsiteDesc is the description of the repo for showing on
    // https://golang.org/pkg/#subrepo.
    // It should be plain text. Hostnames may be auto-linkified.
    WebsiteDesc string
    // contains filtered or unexported fields
}

func (*Repo) GitHubRepo ¶ Uses

func (r *Repo) GitHubRepo() string

GitHubRepo returns the "<org>/<repo>" that this repo either lives at or is mirrored to. It returns the empty string if this repo has no GitHub presence.

func (*Repo) ShowOnDashboard ¶ Uses

func (r *Repo) ShowOnDashboard() bool

ShowOnDashboard reports whether this repo should show up on build.golang.org in the list of repos at bottom.

When this returns true, r.GoGerritProject is guaranteed to be non-empty.

func (*Repo) UsePkgGoDev ¶ Uses

func (r *Repo) UsePkgGoDev() bool

UsePkgGoDev reports whether the repo has opted-in to use pkg.go.dev for displaying documentation for Go packages.