gitfetcher

Documentation

Overview

Package gitfetcher creates local mirrors from remote git repositories.

Index

• func ParseConfig(fp string) (*configpb.Config, error)
• func Sync(ctx context.Context, srcs []*Source, opts *configpb.Options) error
• type Config
• type Source
  • func FindSources(ctx context.Context, cfg *configpb.Config) ([]*Source, error)
• type SyncStatus
  • func GetSyncStatus(src *Source, opts *configpb.Options) SyncStatus

Functions

func ParseConfig

func ParseConfig(fp string) (*configpb.Config, error)

ParseConfig returns a parsed configuration from a given path. The path may either point to a configuration file or a folder, in which case the default configuration file name will be used. The configuration's root will be automatically populated.

func Sync

func Sync(ctx context.Context, srcs []*Source, opts *configpb.Options) error

Sync syncs local copies in the root folder of each source. Missing local repositories will be created, others will be updated as needed.

Types

type Config

type Config = configpb.Config

Config is the generated configuration type, exported here for use in helper signatures.

type Source

type Source struct {
	FullName, FetchURL, Description, DefaultBranch, Path string
	LastUpdatedAt                                        time.Time
	// contains filtered or unexported fields
}

Source captures information about a repository to be mirrored.

func FindSources

func FindSources(ctx context.Context, cfg *configpb.Config) ([]*Source, error)

FindSources returns all sources for the provided configuration.

type SyncStatus

type SyncStatus int

SyncStatus captures possible states of the local repository vs its remote.

const (
	SyncStatusAbsent SyncStatus = iota
	SyncStatusStale
	SyncStatusFresh
)

func GetSyncStatus

func GetSyncStatus(src *Source, opts *configpb.Options) SyncStatus

GetSyncStatus returns the current SyncStatus of a source.