lib

Documentation

Index

• Variables
• type TypeChangeLog
  • func (t *TypeChangeLog) Dump(yes bool) *TypeChangeLog
  • func (t *TypeChangeLog) New(property *TypeChangeLogProperty) *TypeChangeLog
  • func (t *TypeChangeLog) Update() *TypeChangeLog
• type TypeChangeLogProperty
• type TypeConf
  • func (t *TypeConf) New() *TypeConf
• type TypeDocker
  • func (t *TypeDocker) BuildTest(yes bool) *TypeDocker
  • func (t *TypeDocker) Dump(yes bool) *TypeDocker
  • func (t *TypeDocker) New(dir *string, db db.Idb, debug, verbose bool) *TypeDocker
  • func (t *TypeDocker) Update() *TypeDocker
  • func (t *TypeDocker) Updated() bool
• type TypeFlag
• type TypeFlagDbSearch
• type TypeFlagUpdate
• type TypeRepository
  • func (t *TypeRepository) Commit(msg string, tag bool, cache bool) *TypeRepository
  • func (t *TypeRepository) CopyCacheToSrc() *TypeRepository
  • func (t *TypeRepository) CopySrcToCache() *TypeRepository
  • func (t *TypeRepository) New(workPath, dirCache, dirRepo *string, verbose bool) *TypeRepository

Variables

var ConfDefault = TypeConf{
	DirCache:      "~/.cache/go-auto-docker",
	DirDB:         "db",
	DirRepo:       "repo",
	FileConf:      "~/.config/go-auto-docker.json",
	FileLicense:   "LICENSE",
	FileChangeLog: "CHANGELOG.md",

	AlpineBranch: []string{"latest-stable", "edge"},

	TagReadmeLogStart: "<!--CHANGE-LOG-START-->",
	TagReadmeLogEnd:   "<!--CHANGE-LOG-END-->",
}

Types

type TypeChangeLog

type TypeChangeLog struct {
	*basestruct.Base
	*TypeChangeLogProperty
	Content  *[]string `json:"Content"`
	FilePath string    `json:"FilePath"` //README path
}

func (*TypeChangeLog) Dump

func (t *TypeChangeLog) Dump(yes bool) *TypeChangeLog

Dump if [yes] is true

func (*TypeChangeLog) New

func (t *TypeChangeLog) New(property *TypeChangeLogProperty) *TypeChangeLog

New will read [FileChangeLog]

func (*TypeChangeLog) Update

func (t *TypeChangeLog) Update() *TypeChangeLog

Update [Content] buffer and write back

type TypeChangeLogProperty

type TypeChangeLogProperty struct {
	Dir           *string `json:"Dir"`
	FileChangeLog *string `json:"FileChangeLog"` // CHANGELOG.md filename
	Pkg           *string `json:"Pkg"`
	VerCurr       *string `json:"VerCurr"`
	VerNew        *string `json:"VerNew"`
}

type TypeConf

type TypeConf struct {
	*basestruct.Base

	DirCache      string `json:"DirCache"`    // Directory name, not full path, of cache. Default: ~/.cache/go-auto-docker
	DirDB         string `json:"DirDB"`       // Directory name, not full path, of database. Default: db
	DirRepo       string `json:"DirRepo"`     // Directory name, not full path, of repository copy. Default: repo
	FileConf      string `json:"FileConf"`    // Full path of config file. Default: ~/.config/go-auto-docker.json
	FileLicense   string `json:"FileLicense"` // Filename, not full path, of readme file. Default: LICENSE
	FileChangeLog string `json:"FileReadme"`  // Filename, not full path, of readme file. Default: README.md

	AlpineBranch []string `json:"AlpineBranch"`

	// TODO: Change following to array
	TagReadmeLogStart string `json:"ReadmeLogStart"` // Default: <!--CHANGE-LOG-START-->
	TagReadmeLogEnd   string `json:"ReadmeLogEnd"`   // Default: <!--CHANGE-LOG-END-->
}

func (*TypeConf) New

func (t *TypeConf) New() *TypeConf

type TypeDocker

type TypeDocker struct {
	*basestruct.Base

	Content  *[]string `json:"content,omitempty"`
	Dir      string    `json:"dir,omitempty"`
	FilePath string    `json:"file_path,omitempty"`

	Distro string   `json:"distro,omitempty"`
	Branch string   `json:"branch,omitempty"`
	Repo   []string `json:"repo,omitempty"`
	Pkg    string   `json:"pkg,omitempty"`
	PkgRun string   `json:"pkg_run,omitempty"` // The <Pkg=*> string in RUN line

	VerCurr string `json:"ver_curr,omitempty"`
	VerNew  string `json:"ver_new,omitempty"`

	Debug   bool `json:"debug,omitempty"`
	Verbose bool `json:"verbose,omitempty"`
	// contains filtered or unexported fields
}

func (*TypeDocker) BuildTest

func (t *TypeDocker) BuildTest(yes bool) *TypeDocker

BuildTest if [yes] is true

func (*TypeDocker) Dump

func (t *TypeDocker) Dump(yes bool) *TypeDocker

Dump if [yes] is `true`

func (*TypeDocker) New

func (t *TypeDocker) New(dir *string, db db.Idb, debug, verbose bool) *TypeDocker

Assuming branch = main + community

Read and extract information from Dockerfile

func (*TypeDocker) Update

func (t *TypeDocker) Update() *TypeDocker

Update [Content] buffer and write back

func (*TypeDocker) Updated

func (t *TypeDocker) Updated() bool

type TypeFlag

type TypeFlag struct {
	Debug    bool // Enable debug output
	UpdateDb bool // Update package database
	Verbose  bool
}

Holding all flags from command line

type TypeFlagDbSearch

type TypeFlagDbSearch struct {
	Exact bool // Search exact word
}

Holding all flags for db

type TypeFlagUpdate

type TypeFlagUpdate struct {
	Commit    bool // Apply git commit. Only work with -save
	BuildTest bool // Do not perform docker build
	Save      bool // Write back to project folder
	Tag       bool // Apply git tag. Only work with -commit
}

Holding all flags for update

type TypeRepository

type TypeRepository struct {
	*basestruct.Base

	DirCache     string // project copy location
	DirCacheBase string
	DirSrc       string // project(git repo) original location
	Name         string

	Verbose bool
}

func (*TypeRepository) Commit

func (t *TypeRepository) Commit(msg string, tag bool, cache bool) *TypeRepository

func (*TypeRepository) CopyCacheToSrc

func (t *TypeRepository) CopyCacheToSrc() *TypeRepository

func (*TypeRepository) CopySrcToCache

func (t *TypeRepository) CopySrcToCache() *TypeRepository

func (*TypeRepository) New

func (t *TypeRepository) New(workPath, dirCache, dirRepo *string, verbose bool) *TypeRepository