artifacts

Documentation

Overview

Package artifacts provides functionality for writing artifact files in configured artifacts directory. This package operators with a singleton directory variable that can be changed and reset. It provides simple functionality that can be accessible from any calling library.

Index

• Constants
• func Path() string
• func Reset()
• func SetDir(s string)
• func WriteFile(filename string, contents io.Reader) (string, error)

Constants

const DefaultArtifactsDir = "artifacts"

DefaultArtifactsDir is the default value for the directory.

Functions

func Path

func Path() string

Path will return the artifacts directory.

func Reset

func Reset()

Reset restores the default value for the Artifacts Directory.

func SetDir

func SetDir(s string)

SetDir sets the package level artifacts directory. This can be a relative path or a full path.

func WriteFile

func WriteFile(filename string, contents io.Reader) (string, error)

WriteFile will write contents of the string to a file in the artifacts directory. It will create the artifacts dir if necessary. Returns the full path (including the artifacts dir)