particle-os/debian-forge-composer
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

pipeline: add a bit more documentation

Browse source 
Make sure that each of the types have at least a bit of documentation.
This commit is contained in:
Tom Gundersen 2022-06-26 23:20:05 +01:00
parent 4556312d22
commit be2195b235
7 changed files with 33 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

11
internal/pipeline/commit.go
View file

@ -4,14 +4,18 @@ import (
"github.com/osbuild/osbuild-composer/internal/osbuild2"
)
// OSTreeCommitPipeline represents an ostree with one commit.
type OSTreeCommitPipeline struct {
Pipeline
treePipeline *OSPipeline
OSVersion string
OSVersion string
ref string
treePipeline *OSPipeline
ref string
}
// NewOSTreeCommitPipeline creates a new OSTree commit pipeline. The
// treePipeline is the tree representing the content of the commit.
// ref is the ref to create the commit under.
func NewOSTreeCommitPipeline(buildPipeline *BuildPipeline, treePipeline *OSPipeline, ref string) OSTreeCommitPipeline {
return OSTreeCommitPipeline{
Pipeline: New("ostree-commit", buildPipeline, nil),
@ -20,6 +24,7 @@ func NewOSTreeCommitPipeline(buildPipeline *BuildPipeline, treePipeline *OSPipel
}
}
// Ref returns the OSTree ref of the commit.
func (p OSTreeCommitPipeline) Ref() string {
return p.ref
}