synchronization

package

v0.3.2 Latest Latest Go to latest Published: Jul 1, 2021 License: Apache-2.0 Imports: 13 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

This section is empty.

type Config struct {
	Enable     bool
	StorageDir string
	Repository []*Repository
}

Config defines the config structure

func NewConfig() *Config

NewConfig is used to init config with default values

func (c *Config) IsEnabled() bool

IsEnabled is used to return whether the current component is enabled This attribute is required in pluggable components

func (c *Config) RegisterFlagsWithPrefix(prefix string, f *pflag.FlagSet)

RegisterFlags is used to register flags

func (c *Config) Validate() error

Validate is used to validate config and returns error on failure

type Repository struct {
	Address string
	Branch  string
}

type Service struct {
	logger.Logger
	// contains filtered or unexported fields
}

func New(cfg *Config, logger logger.Logger, registerer prometheus.Registerer) (*Service, error)

New is used to init service

func (s *Service) Start(ctx context.Context, cancelFunc context.CancelFunc) error

Start is used to start the service

func (s *Service) Synchronize(ctx context.Context, callback func(repository string, updated bool, err error) error) error

func (s *Service) SynchronizeRepository(ctx context.Context, repository string, branch string, location string) (updated bool, err error)