repos

README

golang.org/x/build/repos

Package repos contains information about Go source repositories.

Documentation

Overview

Package repos contains information about Go source repositories.

Index

• Variables
• type Repo
  • func (r *Repo) ShowOnDashboard() bool

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.

Types

type Repo

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

	// MirrorToCSRProject controls whether this repo is mirrored from
	// Gerrit to Cloud Source Repositories. If not empty, GoGerritProject
	// must be defined. It will be mirrored to a CSR repo in the given
	// project with the same name as the Gerrit repo.
	MirrorToCSRProject string

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

	// GitHubRepo is the "org/repo" of where this repo exists on
	// GitHub. If MirrorToGitHub is true, this is the
	// destination.
	GitHubRepo string

	// 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) ShowOnDashboard

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.