octo

package
v1.38.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 10, 2024 License: Apache-2.0 Imports: 26 Imported by: 0

Documentation

Index

Constants

View Source
const (
	PlatformLinux   = "linux"
	PlatformWindows = "windows"
)
View Source
const (
	CraneVersion            = "0.19.0"
	GoVersion               = "1.20"
	PackVersion             = "0.33.2"
	BuildpackActionsVersion = "5.5.3"
	RichGoVersion           = "0.3.10"
	YJVersion               = "5.1.0"
	Namespace               = "pb"
)
View Source
const (
	FormatFile  = "file"
	FormatImage = "image"
)

Variables

View Source
var RemovedFiles []string

Functions

func Contribute added in v1.5.3

func Contribute(path string) error

func Exists added in v1.5.3

func Exists(path string) (bool, error)

func Find added in v1.5.3

func Find(path string, predicate Predicate) ([]string, error)

func NewDockerCredentialActions added in v1.2.0

func NewDockerCredentialActions(credentials []DockerCredentials) []actions.Step

func NewHttpCredentialActions added in v1.2.0

func NewHttpCredentialActions(credentials []HTTPCredentials) []actions.Step

func Remove added in v1.5.3

func Remove(descriptor Descriptor, removals []string) error

func StatikString added in v1.5.3

func StatikString(path string) string

func Write added in v1.5.3

func Write(descriptor Descriptor, contributions []Contribution) error

Types

type Action

type Action struct {
	Source string
	Target string
}

type Builder

type Builder struct {
	Repository string
}

type CodeOwner

type CodeOwner struct {
	Path  string
	Owner string
}

type Contribution

type Contribution struct {
	Path        string
	Permissions os.FileMode
	Structure   gotree.Tree
	Content     []byte
	Namespace   string
}

func ContributeActions

func ContributeActions(descriptor Descriptor) ([]Contribution, error)

func ContributeBuilderDependencies

func ContributeBuilderDependencies(descriptor Descriptor) ([]Contribution, error)

func ContributeBuildpackDependencies

func ContributeBuildpackDependencies(descriptor Descriptor) ([]Contribution, error)

func ContributeCodeOwners

func ContributeCodeOwners(descriptor Descriptor) Contribution

func ContributeCreateBuilder

func ContributeCreateBuilder(descriptor Descriptor) (*Contribution, error)

func ContributeCreatePackage

func ContributeCreatePackage(descriptor Descriptor) (*Contribution, error)

func ContributeDependabot

func ContributeDependabot(descriptor Descriptor) (*Contribution, error)

func ContributeDraftRelease

func ContributeDraftRelease(descriptor Descriptor) ([]Contribution, error)

func ContributeGit added in v1.37.0

func ContributeGit(descriptor Descriptor) ([]Contribution, error)

func ContributeLabels

func ContributeLabels(descriptor Descriptor) ([]Contribution, error)

func ContributeLitePackages added in v1.13.0

func ContributeLitePackages(descriptor Descriptor) ([]Contribution, error)

func ContributeOfflinePackages

func ContributeOfflinePackages(descriptor Descriptor) ([]Contribution, error)

func ContributePackageDependencies

func ContributePackageDependencies(descriptor Descriptor) ([]Contribution, error)

func ContributeScripts added in v1.37.0

func ContributeScripts(descriptor Descriptor) ([]Contribution, error)

func ContributeTest

func ContributeTest(descriptor Descriptor) (*Contribution, error)

func ContributeUpdateGo added in v1.23.0

func ContributeUpdateGo(descriptor Descriptor) (*Contribution, error)

func ContributeUpdatePipeline added in v1.4.0

func ContributeUpdatePipeline(descriptor Descriptor) (Contribution, error)

func NewActionContribution deprecated

func NewActionContribution(workflow actions.Workflow) (Contribution, error)

Deprecated: use NewActionContributionWithNamespace instead

func NewActionContributionWithNamespace added in v1.25.0

func NewActionContributionWithNamespace(namespace string, workflow actions.Workflow) (Contribution, error)

func NewDependabotContribution

func NewDependabotContribution(dependabot dependabot.Dependabot) (Contribution, error)

func NewDrafterContribution

func NewDrafterContribution(drafter release.Drafter) (Contribution, error)

func NewLabelsContribution

func NewLabelsContribution(labels []labels.Label) (Contribution, error)

type Dependency

type Dependency struct {
	Name           string
	Id             string
	VersionPattern string `yaml:"version_pattern"`
	PURLPattern    string `yaml:"purl_pattern"`
	CPEPattern     string `yaml:"cpe_pattern"`
	Uses           string
	With           map[string]interface{}
}

type Descriptor

type Descriptor struct {
	GitHub            *GitHub
	Path              string
	CodeOwners        []CodeOwner
	Builder           *Builder
	Package           *Package
	DockerCredentials []DockerCredentials `yaml:"docker_credentials"`
	HttpCredentials   []HTTPCredentials   `yaml:"http_credentials"`
	OfflinePackages   []OfflinePackage    `yaml:"offline_packages"`
	RepublishImages   []RepublishImage    `yaml:"republish_images"`
	Actions           []Action
	Dependencies      []Dependency
	Helpers           map[string]string
	Test              Test
}

func NewDescriptor

func NewDescriptor(path string) (Descriptor, error)

type DockerCredentials added in v1.2.0

type DockerCredentials struct {
	Registry string
	Username string
	Password string
}

type GitHub added in v1.6.0

type GitHub struct {
	Username           string
	Token              string
	Mappers            []string
	BuildpackTOMLPaths map[string]string `yaml:"buildpack_toml_paths"`
}

type HTTPCredentials added in v1.2.0

type HTTPCredentials struct {
	Host     string
	Username string
	Password string
}

type OfflinePackage

type OfflinePackage struct {
	Source     string
	Target     string
	SourcePath string `yaml:"source_path"`
	TagPrefix  string `yaml:"tag_prefix"`
	Platform   Platform
}

type Package

type Package struct {
	Repositories        []string
	Repository          string
	IncludeDependencies bool `yaml:"include_dependencies"`
	Register            bool
	RegistryToken       string `yaml:"registry_token"`
	Platform            Platform
	SourcePath          string `yaml:"source_path"`
	Enabled             bool
}

type Platform added in v1.9.0

type Platform struct {
	OS string
}

type Predicate added in v1.5.3

type Predicate func(string) bool

type RepublishImage added in v1.13.0

type RepublishImage struct {
	Source     string
	Target     string
	ID         string
	TagPrefix  string `yaml:"tag_prefix"`
	TargetRepo string `yaml:"target_repo"`
}

type Test added in v1.5.0

type Test struct {
	Steps []actions.Step
}

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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