catalogmetadata

Documentation

Index

• type Bundle
  • func (b *Bundle) HasDeprecation() bool
  • func (b *Bundle) IsDeprecated() bool
  • func (b *Bundle) RequiredPackages() ([]PackageRequired, error)
  • func (b *Bundle) Version() (*bsemver.Version, error)
• type Channel
• type Deprecation
• type Package
• type PackageRequired
• type Schemas

Types

type Bundle

type Bundle struct {
	declcfg.Bundle
	CatalogName  string
	InChannels   []*Channel
	Deprecations []declcfg.DeprecationEntry
	// contains filtered or unexported fields
}

func (*Bundle) HasDeprecation

func (b *Bundle) HasDeprecation() bool

HasDeprecation returns true if the bundle has any deprecations associated with it. This may return true even in cases where the bundle may be associated with an olm.channel deprecation but the bundle is not considered "deprecated" because the bundle is selected via a non-deprecated channel.

func (*Bundle) IsDeprecated

func (b *Bundle) IsDeprecated() bool

IsDeprecated returns true if the bundle has been explicitly deprecated. This can occur if the bundle itself has been deprecated. this function does not take into consideration olm.channel or olm.package deprecations associated with the bundle as a bundle can be present in multiple channels with some channels being deprecated and some not Package deprecation does not carry the same meaning as an individual bundle deprecation, so package deprecation is not considered.

func (*Bundle) RequiredPackages

func (b *Bundle) RequiredPackages() ([]PackageRequired, error)

func (*Bundle) Version

func (b *Bundle) Version() (*bsemver.Version, error)

type Channel

type Channel struct {
	declcfg.Channel
}

type Deprecation

type Deprecation struct {
	declcfg.Deprecation
}

type Package

type Package struct {
	declcfg.Package
}

type PackageRequired

type PackageRequired struct {
	property.PackageRequired
	SemverRange bsemver.Range `json:"-"`
}

type Schemas

type Schemas interface {
	Package | Bundle | Channel | Deprecation
}