release

Documentation

Index

• type ArchiveIndicies
• type ArchiveReader
  • func NewArchiveReader(jobArchiveReader boshjob.ArchiveReader, pkgArchiveReader boshpkg.ArchiveReader, ...) ArchiveReader
  • func (r ArchiveReader) Read(path string) (Release, error)
• type ArchiveWriter
  • func NewArchiveWriter(compressor boshcmd.Compressor, fs boshsys.FileSystem, logger boshlog.Logger) ArchiveWriter
  • func (w ArchiveWriter) Write(release Release, pkgFpsToSkip []string) (string, error)
• type BuiltReader
  • func NewBuiltReader(releaseReader Reader, devIndicies ArchiveIndicies, ...) BuiltReader
  • func (r BuiltReader) Read(path string) (Release, error)
• type DirReader
  • func NewDirReader(jobDirReader boshjob.DirReader, pkgDirReader boshpkg.DirReader, ...) DirReader
  • func (r DirReader) Read(path string) (Release, error)
• type Extractor
• type Manager
• type ManifestReader
  • func NewManifestReader(fs boshsys.FileSystem, logger boshlog.Logger) ManifestReader
  • func (r ManifestReader) Read(path string) (Release, error)
• type MultiReader
  • func NewMultiReader(opts MultiReaderOpts, fs boshsys.FileSystem) MultiReader
  • func (r MultiReader) Read(path string) (Release, error)
• type MultiReaderOpts
• type Provider
  • func NewProvider(cmdRunner boshsys.CmdRunner, compressor boshcmd.Compressor, ...) Provider
  • func (p Provider) NewArchiveReader() ArchiveReader
  • func (p Provider) NewArchiveWriter() ArchiveWriter
  • func (p Provider) NewDirReader(dirPath string) DirReader
  • func (p Provider) NewExtractingArchiveReader() ArchiveReader
  • func (p Provider) NewManifestReader() ManifestReader
  • func (p Provider) NewMultiReader(dirPath string) MultiReader
• type Reader
• type Release
  • func NewRelease(name string, version string, commitHash string, uncommittedChanges bool, ...) Release
• type Writer

Types

type ArchiveIndicies

type ArchiveIndicies struct {
	Jobs     boshres.ArchiveIndex
	Packages boshres.ArchiveIndex
	Licenses boshres.ArchiveIndex
}

type ArchiveReader

type ArchiveReader struct {
	// contains filtered or unexported fields
}

func NewArchiveReader

func NewArchiveReader(
	jobArchiveReader boshjob.ArchiveReader,
	pkgArchiveReader boshpkg.ArchiveReader,
	compressor boshcmd.Compressor,
	fs boshsys.FileSystem,
	logger boshlog.Logger,
) ArchiveReader

func (ArchiveReader) Read

func (r ArchiveReader) Read(path string) (Release, error)

type ArchiveWriter

type ArchiveWriter struct {
	// contains filtered or unexported fields
}

func NewArchiveWriter

func NewArchiveWriter(compressor boshcmd.Compressor, fs boshsys.FileSystem, logger boshlog.Logger) ArchiveWriter

func (ArchiveWriter) Write

func (w ArchiveWriter) Write(release Release, pkgFpsToSkip []string) (string, error)

type BuiltReader

type BuiltReader struct {
	// contains filtered or unexported fields
}

func NewBuiltReader

func NewBuiltReader(
	releaseReader Reader,
	devIndicies ArchiveIndicies,
	finalIndicies ArchiveIndicies,
) BuiltReader

func (BuiltReader) Read

func (r BuiltReader) Read(path string) (Release, error)

type DirReader

type DirReader struct {
	// contains filtered or unexported fields
}

func NewDirReader

func NewDirReader(
	jobDirReader boshjob.DirReader,
	pkgDirReader boshpkg.DirReader,
	licDirReader boshlic.DirReader,
	fs boshsys.FileSystem,
	logger boshlog.Logger,
) DirReader

func (DirReader) Read

func (r DirReader) Read(path string) (Release, error)

type Extractor

type Extractor interface {
	Extract(string) (Release, error)
}

type Manager

type Manager interface {
	Add(Release)
	List() []Release
	Find(string) (Release, bool)
	DeleteAll() error
}

type ManifestReader

type ManifestReader struct {
	// contains filtered or unexported fields
}

func NewManifestReader

func NewManifestReader(fs boshsys.FileSystem, logger boshlog.Logger) ManifestReader

func (ManifestReader) Read

func (r ManifestReader) Read(path string) (Release, error)

type MultiReader

type MultiReader struct {
	// contains filtered or unexported fields
}

func NewMultiReader

func NewMultiReader(opts MultiReaderOpts, fs boshsys.FileSystem) MultiReader

func (MultiReader) Read

func (r MultiReader) Read(path string) (Release, error)

type MultiReaderOpts

type MultiReaderOpts struct {
	ArchiveReader  Reader
	ManifestReader Reader
	DirReader      Reader
}

type Provider

type Provider struct {
	// contains filtered or unexported fields
}

func NewProvider

func NewProvider(
	cmdRunner boshsys.CmdRunner,
	compressor boshcmd.Compressor,
	digestCalculator bicrypto.DigestCalculator,
	fs boshsys.FileSystem,
	logger boshlog.Logger,
) Provider

func (Provider) NewArchiveReader

func (p Provider) NewArchiveReader() ArchiveReader

func (Provider) NewArchiveWriter

func (p Provider) NewArchiveWriter() ArchiveWriter

func (Provider) NewDirReader

func (p Provider) NewDirReader(dirPath string) DirReader

func (Provider) NewExtractingArchiveReader

func (p Provider) NewExtractingArchiveReader() ArchiveReader

func (Provider) NewManifestReader

func (p Provider) NewManifestReader() ManifestReader

func (Provider) NewMultiReader

func (p Provider) NewMultiReader(dirPath string) MultiReader

type Reader

type Reader interface {
	// Read reads an archive for example and returns a Release.
	Read(string) (Release, error)
}

type Release

type Release interface {
	Name() string
	SetName(string)

	Version() string
	SetVersion(string)

	CommitHashWithMark(string) string
	SetCommitHash(string)
	SetUncommittedChanges(bool)

	Jobs() []*boshjob.Job
	Packages() []*boshpkg.Package
	CompiledPackages() []*boshpkg.CompiledPackage
	License() *boshlic.License

	IsCompiled() bool

	FindJobByName(string) (boshjob.Job, bool)
	Manifest() boshman.Manifest

	Build(dev, final ArchiveIndicies) error
	Finalize(final ArchiveIndicies) error

	CleanUp() error
}

func NewRelease

func NewRelease(
	name string,
	version string,
	commitHash string,
	uncommittedChanges bool,
	jobs []*bireljob.Job,
	packages []*birelpkg.Package,
	compiledPkgs []*birelpkg.CompiledPackage,
	license *birellic.License,
	extractedPath string,
	fs boshsys.FileSystem,
) Release

type Writer

type Writer interface {
	// Write writes an archive for example and returns its path.
	// Archive does not include packages that have fingerprints
	// included in the second argument.
	Write(Release, []string) (string, error)
}