registry

Documentation

Index

• type Entry
• type EntryApp
• type EntryConfig
  • func (e *EntryConfig) IsCompatible() bool
• type EntryService
• type Source
  • func FileSystem(path string) Source
  • func GitHub() Source

Types

type Entry

type Entry struct {
	Name        string        `json:"name" yaml:"name"`
	Description string        `json:"description" yaml:"description"`
	Configs     []EntryConfig `json:"configs" yaml:"configs"`
}

Entry represents a registry entry which may be added to your configuration.

type EntryApp

type EntryApp struct {
	Name        string   `json:"name" yaml:"name"`
	Command     string   `json:"command" yaml:"command"`
	Arguments   []string `json:"args" yaml:"args"`
	Environment []string `json:"environment" yaml:"environment"`
}

EntryApp is used to configure an application for a user.

type EntryConfig

type EntryConfig struct {
	Platform string        `json:"platform" yaml:"platform"`
	App      *EntryApp     `json:"app,omitempty" yaml:"app,omitempty"`
	Service  *EntryService `json:"service,omitempty" yaml:"service,omitempty"`
}

EntryConfig is a platform-specific configuration which should be applied for this entry.

func (*EntryConfig) IsCompatible

func (e *EntryConfig) IsCompatible() bool

IsCompatible determines whether this EntryConfig is compatible with the current platform.

type EntryService

type EntryService struct {
	Domain string `json:"domain" yaml:"domain"`

	Website string `json:"website" yaml:"website"`
	HTTPURL string `json:"httpUrl" yaml:"httpUrl"`
	GitURL  string `json:"gitUrl" yaml:"gitUrl"`

	Pattern string `json:"pattern" yaml:"pattern"`
}

EntryService is used to configure a new service for a user.

type Source

type Source interface {
	GetEntries() ([]string, error)
	GetEntry(id string) (*Entry, error)
}

A Source is used to provide entries

func FileSystem

func FileSystem(path string) Source

FileSystem creates a configuration source which uses a filesystem directory to hold entries.

func GitHub

func GitHub() Source

GitHub acts as a source of configuration entries used by Git-Tool.