source

Documentation

Overview

Package source retrieves source code

Index

• type Option
  • func Path(p string) Option
• type Options
• type Repository
• type Source

Types

type Option

type Option func(o *Options)

func Path

func Path(p string) Option

Local path for repository.

type Options

type Options struct {
	// local path to download source
	Path string
}

type Repository

type Repository struct {
	// Name or repo
	Name string
	// Local path where repo is stored
	Path string
	// URL from which repo was retrieved
	URL string
}

Repository is the source repository.

type Source

type Source interface {
	// Fetch repo from a url
	Fetch(url string) (*Repository, error)
	// Commit and upload repo
	Commit(*Repository) error
	// The sourcerer
	String() string
}

Source retrieves source code.