utils

Documentation

Index

• func BranchFromGitRef(ref string) (string, error)
• func DecodeSignature(s string) ([]byte, error)
• func IsValidBuilderTag(ref string, testing bool) error
• func IsValidJreleaserBuilderTag(ref string) error
• func MergeMaps[K comparable, V any](m1, m2 map[K]V) map[K]V
• func NormalizeGitURI(s string) string
• func ParseBuilderID(id string, needVersion bool) (string, string, error)
• func ParseGitRef(ref string) (string, string)
• func ParseGitURIAndRef(uri string) (string, string, error)
• func PayloadFromEnvelope(env *dsselib.Envelope) ([]byte, error)
• func TagFromGitRef(ref string) (string, error)
• func ValidateGitRef(refType, ref string) (string, error)
• func VerifyVersionedTag(provenanceTag, expectedTag string) error
• type TrustedBuilderID
  • func TrustedBuilderIDNew(builderID string, needVersion bool) (*TrustedBuilderID, error)
  • func (b *TrustedBuilderID) MatchesFull(builderID string, allowRef bool) error
  • func (b *TrustedBuilderID) MatchesLoose(builderID string, allowRef bool) error
  • func (b *TrustedBuilderID) Name() string
  • func (b *TrustedBuilderID) String() string
  • func (b *TrustedBuilderID) Version() string

Functions

func BranchFromGitRef

func BranchFromGitRef(ref string) (string, error)

BranchFromGitRef returns the tagname from a tag ref.

func DecodeSignature

func DecodeSignature(s string) ([]byte, error)

func IsValidBuilderTag

func IsValidBuilderTag(ref string, testing bool) error

IsValidBuilderTag validates if the given ref is a valid builder tag.

func IsValidJreleaserBuilderTag

func IsValidJreleaserBuilderTag(ref string) error

func MergeMaps

func MergeMaps[K comparable, V any](m1, m2 map[K]V) map[K]V

func NormalizeGitURI

func NormalizeGitURI(s string) string

NormalizeGitURI normalizes a git URI to include a git+https:// prefix.

func ParseBuilderID

func ParseBuilderID(id string, needVersion bool) (string, string, error)

ParseBuilderID parses the builder ID into the URI and ref parts.

func ParseGitRef

func ParseGitRef(ref string) (string, string)

ParseGitRef parses the git ref and returns its type and name.

func ParseGitURIAndRef

func ParseGitURIAndRef(uri string) (string, string, error)

ParseGitURIAndRef retrieves the URI and ref from the given URI.

func PayloadFromEnvelope

func PayloadFromEnvelope(env *dsselib.Envelope) ([]byte, error)

func TagFromGitRef

func TagFromGitRef(ref string) (string, error)

TagFromGitRef returns the tagname from a tag ref.

func ValidateGitRef

func ValidateGitRef(refType, ref string) (string, error)

ValidateGitRef validates that the given git ref is a valid ref of the given type and returns its name.

func VerifyVersionedTag

func VerifyVersionedTag(provenanceTag, expectedTag string) error

Types

type TrustedBuilderID

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

TrustedBuilderID represents a builder ID that has been explicitly trusted.

func TrustedBuilderIDNew

func TrustedBuilderIDNew(builderID string, needVersion bool) (*TrustedBuilderID, error)

TrustedBuilderIDNew creates a new BuilderID structure.

func (*TrustedBuilderID) MatchesFull

func (b *TrustedBuilderID) MatchesFull(builderID string, allowRef bool) error

MatchesFull matches the builderID string against the reference builderID. Both the name and versions are always verified.

func (*TrustedBuilderID) MatchesLoose

func (b *TrustedBuilderID) MatchesLoose(builderID string, allowRef bool) error

MatchesLoose matches the builderID string against the reference builderID. If the builderID contains a semver, the full builderID must match. Otherwise, only the name needs to match. `allowRef: true` indicates that the matching need not be an eaxct match. In this case, if the BuilderID version is a GitHub ref `refs/tags/name`, we will consider it equal to user-provided builderID `name`.

func (*TrustedBuilderID) Name

func (b *TrustedBuilderID) Name() string

Name returns the trusted builder's name.

func (*TrustedBuilderID) String

func (b *TrustedBuilderID) String() string

String returns the full trusted builder ID as a string.

func (*TrustedBuilderID) Version

func (b *TrustedBuilderID) Version() string

Version returns the trusted builder's version reference if any.