Documentation ¶
Index ¶
- Variables
- func AddFile(a Archive, file string) error
- func GOPATH() string
- func MustRun(cmd *exec.Cmd)
- func MustRunCommand(cmd string, args ...string)
- func Render(templateFile, outputFile string, outputPerm os.FileMode, x interface{})
- func RenderString(templateContent, outputFile string, outputPerm os.FileMode, x interface{})
- func RunGit(args ...string) string
- func VERSION() string
- func WriteArchive(basename, ext string, files []string) error
- type Archive
- type Environment
- type TarballArchive
- type ZipArchive
Constants ¶
This section is empty.
Variables ¶
View Source
var ( // These flags override values in build env. GitCommitFlag = flag.String("git-commit", "", `Overrides git commit hash embedded into executables`) GitBranchFlag = flag.String("git-branch", "", `Overrides git branch being built`) GitTagFlag = flag.String("git-tag", "", `Overrides git tag being built`) BuildnumFlag = flag.String("buildnum", "", `Overrides CI build number`) PullRequestFlag = flag.Bool("pull-request", false, `Overrides pull request status of the build`) )
View Source
var DryRunFlag = flag.Bool("n", false, "dry run, don't execute commands")
Functions ¶
func GOPATH ¶
func GOPATH() string
GOPATH returns the value that the GOPATH environment variable should be set to.
func MustRunCommand ¶
func RenderString ¶
RenderString renders the given template string into outputFile.
func RunGit ¶
RunGit runs a git subcommand and returns its output. The command must complete successfully.
func VERSION ¶ added in v1.4.11
func VERSION() string
VERSION returns the content of the VERSION file.
func WriteArchive ¶
WriteArchive creates an archive containing the given files.
Types ¶
type Archive ¶
type Archive interface { // Directory adds a new directory entry to the archive and sets the // directory for subsequent calls to Header. Directory(name string) error // Header adds a new file to the archive. The file is added to the directory // set by Directory. The content of the file must be written to the returned // writer. Header(os.FileInfo) (io.Writer, error) // Close flushes the archive and closes the underlying file. Close() error }
func NewArchive ¶
func NewTarballArchive ¶
func NewTarballArchive(w io.WriteCloser) Archive
func NewZipArchive ¶
func NewZipArchive(w io.WriteCloser) Archive
type Environment ¶
type Environment struct { Name string // name of the environment Repo string // name of GitHub repo Commit, Branch, Tag string // Git info Buildnum string IsPullRequest bool }
Environment contains metadata provided by the build environment.
func Env ¶
func Env() Environment
Env returns metadata about the current CI environment, falling back to LocalEnv if not running on CI.
func LocalEnv ¶
func LocalEnv() Environment
LocalEnv returns build environment metadata gathered from git.
func (Environment) String ¶
func (env Environment) String() string
type TarballArchive ¶
type TarballArchive struct {
// contains filtered or unexported fields
}
func (*TarballArchive) Close ¶
func (a *TarballArchive) Close() error
func (*TarballArchive) Directory ¶
func (a *TarballArchive) Directory(name string) error
type ZipArchive ¶
type ZipArchive struct {
// contains filtered or unexported fields
}
func (*ZipArchive) Close ¶
func (a *ZipArchive) Close() error
func (*ZipArchive) Directory ¶
func (a *ZipArchive) Directory(name string) error
Click to show internal directories.
Click to hide internal directories.