git

Documentation

Overview

Package git implements the module.git component.

Index

• Variables
• type Arguments
  • func (args *Arguments) SetToDefault()
• type Component
  • func New(o component.Options, args Arguments) (*Component, error)
  • func (c *Component) CurrentHealth() component.Health
  • func (c *Component) DebugInfo() interface{}
  • func (c *Component) Run(ctx context.Context) error
  • func (c *Component) Update(args component.Arguments) (err error)

Variables

var DefaultArguments = Arguments{
	Revision:      "HEAD",
	PullFrequency: time.Minute,
}

DefaultArguments holds default settings for Arguments.

Types

type Arguments

type Arguments struct {
	Repository    string        `river:"repository,attr"`
	Revision      string        `river:"revision,attr,optional"`
	Path          string        `river:"path,attr"`
	PullFrequency time.Duration `river:"pull_frequency,attr,optional"`

	Arguments     map[string]any    `river:"arguments,block,optional"`
	GitAuthConfig vcs.GitAuthConfig `river:",squash"`
}

Arguments configures the module.git component.

func (*Arguments) SetToDefault

func (args *Arguments) SetToDefault()

SetToDefault implements river.Defaulter.

type Component

type Component struct {
	// contains filtered or unexported fields
}

Component implements the module.git component.

func New

func New(o component.Options, args Arguments) (*Component, error)

New creates a new module.git component.

func (*Component) CurrentHealth

func (c *Component) CurrentHealth() component.Health

CurrentHealth implements component.HealthComponent.

func (*Component) DebugInfo

func (c *Component) DebugInfo() interface{}

DebugInfo implements component.DebugComponent.

func (*Component) Run

func (c *Component) Run(ctx context.Context) error

Run implements component.Component.

func (*Component) Update

func (c *Component) Update(args component.Arguments) (err error)

Update implements component.Component.