discovery

type GitHubResolver ¶

type GitHubResolver struct {
	Client *github.Client
}

GitHubResolver resolves github:topic/<topic> meta-sources via the GitHub API.

func NewGitHubResolver(client *github.Client) *GitHubResolver

func NewGitHubResolverUnauthenticated() *GitHubResolver

func NewGitHubResolverWithToken(token string) *GitHubResolver

func (r *GitHubResolver) Handles(source string) bool

func (r *GitHubResolver) Resolve(source string) ([]ResolvedRepo, error)

type ResolvedRepo ¶

type ResolvedRepo struct {
	URL          string // git clone URL
	Branch       string // branch to fetch from
	Origin       string // how this repo was discovered (e.g. "explicit", "github:topic/vctm")
	Organization string // explicit organization label (empty = infer from URL)
}

ResolvedRepo is a concrete git repository to fetch credential data from.

func ResolveAll(manifest *SourceManifest, resolvers []Resolver) ([]ResolvedRepo, error)

type Resolver ¶

type Resolver interface {
	// Resolve takes a meta-source URI and returns the repos it resolves to.
	Resolve(source string) ([]ResolvedRepo, error)
	// Handles returns true if this resolver can handle the given source URI scheme.
	Handles(source string) bool
}

Resolver resolves meta-sources into concrete repos.

type SourceDefaults ¶

type SourceDefaults struct {
	Branch string `yaml:"branch"`
}

SourceDefaults contains default settings applied to all resolved repos.

type SourceEntry ¶ added in v0.7.0

type SourceEntry struct {
	URL          string `yaml:"url"`
	Organization string `yaml:"organization,omitempty"`
	Branch       string `yaml:"branch,omitempty"`
}

SourceEntry represents a source in the manifest. It can be either a plain string URI or a struct with explicit organization and branch overrides.

Plain string:

sources:
  - "git:https://github.com/org/repo.git"

Struct with organization and branch:

sources:
  - url: "git:https://github.com/org/repo.git"
    organization: "MyOrg"
    branch: "vctm"

func (s *SourceEntry) UnmarshalYAML(value *yaml.Node) error

type SourceManifest ¶

type SourceManifest struct {
	Sources  []SourceEntry  `yaml:"sources"`
	Defaults SourceDefaults `yaml:"defaults"`
}

SourceManifest is the top-level structure of a sources.yaml file.

func LoadManifest(path string) (*SourceManifest, error)