Documentation
¶
Index ¶
- Variables
- func SplitDocuments(s string) ([]string, error)
- type ByteReader
- type ByteWriter
- type CommitByteReader
- type CommitYAMLReader
- type DirReader
- type FileReader
- type GitReader
- type GitWriter
- type InventoryReader
- type KformDirReader
- type KformFileReader
- type KformMemReader
- type KformStreamReader
- type KformWriter
- type MatchFilesGlob
- type MemReader
- type OutputSink
- type Pipeline
- type PkgPushReadWriter
- type Process
- type Reader
- type Writer
- type YAMLDirReader
- type YAMLMemReader
- type YAMLReader
- type YAMLWriter
Constants ¶
This section is empty.
Variables ¶
View Source
var IgnoreFileMatch = []string{".ignore"}
View Source
var JSONMatch = []string{"*.json"}
View Source
var MarkdownMatch = []string{"*.md"}
View Source
var MatchAll = []string{"*"}
View Source
var ReadmeFileMatch = []string{"README.md"}
View Source
var YAMLMatch = []string{"*.yaml", "*.yml"}
Functions ¶
func SplitDocuments ¶ added in v0.0.3
splitDocuments returns a slice of all documents contained in a YAML string. Multiple documents can be divided by the YAML document separator (---). It allows for white space and comments to be after the separator on the same line, but will return an error if anything else is on the line.
Types ¶
type ByteReader ¶ added in v0.0.3
type ByteWriter ¶ added in v0.0.3
type ByteWriter struct {
Type OutputSink
// Could be a file or directory
Path string
}
type CommitByteReader ¶ added in v0.0.15
type CommitYAMLReader ¶ added in v0.0.15
type DirReader ¶ added in v0.0.3
type FileReader ¶ added in v0.0.3
type GitReader ¶ added in v0.0.3
type GitReader struct {
// URL of the Git Repository
URL string
// Secret with crendentials to access the repo
Secret string
// Deployment determines if this is a catalog repo or not
Deployment bool
// Directory used in the git repository as an offset
Directory string
// PackageID identifies target, repo, realm, package, workspace and revision (if assigned)
PkgRevID *pkgrevid.PackageRevID
// PkgPath identifies the localation of the package in the local filesystem
PkgPath string
// allows the consumer to specify its own data store
DataStore store.Storer[[]byte]
}
type GitWriter ¶ added in v0.0.3
type GitWriter struct {
// URL of the Git Repository
URL string
// Secret with crendentials to access the repo
Secret string
// Deployment determines if this is a catalog repo or not
Deployment bool
// Directory used in the git repository as an offset
Directory string
// PackageID identifies target, repo, realm, package, workspace and revision (if assigned)
PkgRevID *pkgrevid.PackageRevID
// PkgPath identifies the localation of the package in the local filesystem
PkgPath string
}
type InventoryReader ¶ added in v0.0.3
type InventoryReader struct {
}
type KformDirReader ¶ added in v0.0.3
type KformFileReader ¶ added in v0.0.3
type KformMemReader ¶ added in v0.0.3
type KformStreamReader ¶ added in v0.0.3
type KformWriter ¶ added in v0.0.3
type KformWriter struct {
//Writer io.Writer
Type OutputSink
// Could be a file or directory
Path string
OuputData store.Storer[[]byte] // used for memory
}
type MatchFilesGlob ¶ added in v0.0.3
type MatchFilesGlob []string
func (MatchFilesGlob) ShouldSkipFile ¶ added in v0.0.10
func (m MatchFilesGlob) ShouldSkipFile(path string) (bool, error)
type OutputSink ¶ added in v0.0.3
type OutputSink int64
const ( OutputSink_None OutputSink = iota OutputSink_File OutputSink_FileRetain OutputSink_Dir OutputSink_StdOut OutputSink_Memory )
type Pipeline ¶
type PkgPushReadWriter ¶ added in v0.0.7
func NewPkgPushReadWriter ¶ added in v0.0.7
type YAMLDirReader ¶ added in v0.0.11
type YAMLDirReader struct {
FsysPath string
RelFsysPath string
Fsys fs.FS
SkipDir bool
MatchGVKs []schema.GroupVersionKind
}
only read yaml
type YAMLMemReader ¶ added in v0.0.15
type YAMLReader ¶ added in v0.0.3
Source Files
¶
- annotation_types.go
- byte_reader.go
- byte_writer.go
- commit_byte_reader.go
- commit_yaml_reader.go
- dir_reader.go
- file.go
- file_reader.go
- git_reader.go
- git_writer.go
- inventory_package_reader.go
- inventory_provider_reader.go
- inventory_reader.go
- kform_dir_reader.go
- kform_file_reader.go
- kform_mem_reader.go
- kform_stream_reader.go
- kform_writer.go
- mem_reader.go
- output.go
- pkgio.go
- pkgio_push.go
- yaml_dir_reader.go
- yaml_mem_reader.go
- yaml_reader.go
- yaml_writer.go
Click to show internal directories.
Click to hide internal directories.