v1

package

v0.30.11 Latest Latest Go to latest Published: Apr 19, 2024 License: Apache-2.0 Imports: 12 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/snyk/policy-engine

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func BuildBundle(p base.FileProducer, opts ...ManifestOption) (base.Bundle, error)
func ReadBundle(p base.FileProducer) (base.Bundle, error)
type Bundle
type Manifest
- func (m *Manifest) Validate() error
type ManifestOption
type VCSMetadata

Constants ¶

View Source

const VERSION = "v1"

Variables ¶

View Source

var ErrInvalidBundle = errors.New("invalid bundle")

View Source

var ErrInvalidManifest = errors.New("invalid manifest")

Functions ¶

func BuildBundle ¶

func BuildBundle(p base.FileProducer, opts ...ManifestOption) (base.Bundle, error)

func ReadBundle ¶

func ReadBundle(p base.FileProducer) (base.Bundle, error)

Types ¶

type Bundle ¶

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

func (*Bundle) BundleFormatVersion ¶

func (b *Bundle) BundleFormatVersion() string

func (*Bundle) Document ¶

func (b *Bundle) Document() map[string]interface{}

func (*Bundle) Manifest ¶

func (b *Bundle) Manifest() interface{}

func (*Bundle) Modules ¶

func (b *Bundle) Modules() map[string]*ast.Module

func (*Bundle) Provider ¶

func (b *Bundle) Provider() data.Provider

func (*Bundle) SourceInfo ¶

func (b *Bundle) SourceInfo() base.SourceInfo

func (*Bundle) Validate ¶

func (b *Bundle) Validate() error

type Manifest ¶

type Manifest struct {
	base.Manifest
	Name                string      `json:"name"`
	PolicyEngineVersion string      `json:"policy_engine_version"`
	Revision            string      `json:"revision"`
	VCS                 VCSMetadata `json:"vcs"`
}

func (*Manifest) Validate ¶

func (m *Manifest) Validate() error

type ManifestOption ¶

type ManifestOption func(m *Manifest)

func WithRevision ¶

func WithRevision(r string) ManifestOption

func WithVCSType ¶

func WithVCSType(t string) ManifestOption

func WithVCSURI ¶

func WithVCSURI(u string) ManifestOption

type VCSMetadata ¶

type VCSMetadata struct {
	Type string `json:"type"`
	URI  string `json:"uri"`
}

Source Files ¶

View all Source files

bundle.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL