forgepb

README

protobuf definition files for forge

Documentation

Overview

Example

This example is copied from rill to understand golang docs

package main

import (
	"fmt"
)

func main() {
	fmt.Println("nothing here yet")
}

Example (Batching)

This example is copied from rill to understand golang docs

package main

import (
	"fmt"
)

func main() {
	fmt.Println("nothing batching here yet")
}

Index

• Variables
• func FindGoSrc() (string, error)
• func IsGitDir(dir string) bool
• type Forge
  • func Init() *Forge
  • func (f *Forge) ConfigPrintTable()
  • func (f *Forge) ConfigSave() error
  • func (f *Forge) DebName(gopath string) string
  • func (f *Forge) GetGoSrc() string
  • func (f *Forge) IsFavorite(thing string) bool
  • func (f *Forge) IsPrivate(thing string) bool
  • func (f *Forge) IsReadOnly(gopath string) bool
  • func (f *Forge) ScanGoSrc() (bool, error)
  • func (f *Forge) SortByPath() *ForgeConfigIterator

Examples

• Package
• Package (Batching)

Variables

var FORGEPB *log.LogFlag

var FORGEPBWARN *log.LogFlag

Functions

func FindGoSrc

func FindGoSrc() (string, error)

look for a go.work file otherwise use ~/go/src

func IsGitDir

func IsGitDir(dir string) bool

IsGitDir checks if a .git directory exists inside the given directory

Types

type Forge

type Forge struct {
	Config  *ForgeConfigs // config repos for readonly, private, etc
	Repos   *gitpb.Repos
	Machine *zoopb.Machine
	// contains filtered or unexported fields
}

maybe an interface someday?

func Init

func Init() *Forge

func (*Forge) ConfigPrintTable

func (f *Forge) ConfigPrintTable()

print a human readable table to STDOUT

func (*Forge) ConfigSave

func (f *Forge) ConfigSave() error

write to ~/.config/forge/ unless ENV{FORGE_HOME} is set

func (*Forge) DebName

func (f *Forge) DebName(gopath string) string

returns the deb package name this let's you check a git tag version against a package .deb version allows gopath's to not need to match the .deb name this is important in lots of cases! It is normal and happens often enough.

func (*Forge) GetGoSrc

func (f *Forge) GetGoSrc() string

func (*Forge) IsFavorite

func (f *Forge) IsFavorite(thing string) bool

IsFavorite() -- fun option for the config file that lets you set things as favorites so you can just go-clone a bunch of common things on a new box or after you reset/delete your ~/go/src dir

func (*Forge) IsPrivate

func (f *Forge) IsPrivate(thing string) bool

is this a non-publishable repo? matches package names from apt

IsPrivate("foo") will match anything in the config file ending in "foo"

IsPrivate("go.foo.com/jcarr/foo") returns true if private IsPrivate("foo") also returns true if "go.bar.com/jcarr/foo" is private

func (*Forge) IsReadOnly

func (f *Forge) IsReadOnly(gopath string) bool

returns true if gopath is readonly() will attempt to match IsWritable("foo") against anything ending in "foo"

func (*Forge) ScanGoSrc

func (f *Forge) ScanGoSrc() (bool, error)

func (*Forge) SortByPath

func (f *Forge) SortByPath() *ForgeConfigIterator