bufmodulebuild

Documentation

Index

• type BuildModuleFileSetOption
  • func WithWorkspace(workspace bufmodule.Workspace) BuildModuleFileSetOption
• type BuildOption
  • func WithExcludePaths(excludePaths []string) BuildOption
  • func WithExcludePathsAllowNotExist(excludePaths []string) BuildOption
  • func WithModuleIdentity(moduleIdentity bufmoduleref.ModuleIdentity) BuildOption
  • func WithPaths(paths []string) BuildOption
  • func WithPathsAllowNotExist(paths []string) BuildOption
• type BuiltModule
• type ModuleBucketBuilder
  • func NewModuleBucketBuilder() ModuleBucketBuilder
• type ModuleFileSetBuilder
  • func NewModuleFileSetBuilder(logger *zap.Logger, moduleReader bufmodule.ModuleReader) ModuleFileSetBuilder
• type ModuleIncludeBuilder
  • func NewModuleIncludeBuilder(logger *zap.Logger, storageosProvider storageos.Provider) ModuleIncludeBuilder

Types

type BuildModuleFileSetOption

type BuildModuleFileSetOption func(*buildModuleFileSetOptions)

BuildModuleFileSetOption is an option for Build.

func WithWorkspace

func WithWorkspace(workspace bufmodule.Workspace) BuildModuleFileSetOption

WithWorkspace returns a new BuildModuleFileSetOption that specifies a workspace.

type BuildOption

type BuildOption func(*buildOptions)

BuildOption is an option for BuildForBucket.

func WithExcludePaths

func WithExcludePaths(excludePaths []string) BuildOption

WithExcludePaths returns a new BuildOption that specifies files to be excluded from the build.

func WithExcludePathsAllowNotExist

func WithExcludePathsAllowNotExist(excludePaths []string) BuildOption

WithExcludePathsAllowNotExist returns a new BuildOption that specifies files to be excluded from the build, but allows the specified paths to not exist.

func WithModuleIdentity

func WithModuleIdentity(moduleIdentity bufmoduleref.ModuleIdentity) BuildOption

WithModuleIdentity returns a new BuildOption that is used to construct a Module with a ModuleIdentity.

TODO: this is never called TODO: we also have ModuleWithModuleIdentityAndCommit in bufmodule We need to disambiguate module building between bufmodule and bufmodulebuild bufimage and bufimagebuild work, but bufmodule and bufmodulebuild are a mess

func WithPaths

func WithPaths(paths []string) BuildOption

WithPaths returns a new BuildOption that specifies specific file or directory paths to build.

These paths must exist. These paths must be relative to the bucket or include directory paths. These paths will be normalized. Multiple calls to this option and WithPathsAllowNotExist will override previous calls.

This results in ModuleWithTargetPaths being used on the resulting build module. This is done within bufmodulebuild so we can resolve the paths relative to their roots.

func WithPathsAllowNotExist

func WithPathsAllowNotExist(paths []string) BuildOption

WithPathsAllowNotExist returns a new BuildOption that specifies specific file or directory paths to build, but allows the specified paths to not exist.

These paths must exist. These paths must be relative to the bucket or include directory paths. These paths will be normalized. Multiple calls to this option and WithPaths will override previous calls.

This results in ModuleWithPathsAllowNotExist being used on the resulting build module. This is done within bufmodulebuild so we can resolve the paths relative to their roots.

type BuiltModule

type BuiltModule struct {
	bufmodule.Module
	Bucket storage.ReadBucket
}

BuiltModule ties a bufmodule.Module with the configuration and a bucket containing just the files required to build it.

type ModuleBucketBuilder

type ModuleBucketBuilder interface {
	// BuildForBucket constructs a minimal bucket from the passed readBucket and
	// builds a module from it.
	//
	// config's value is used even if the bucket contains configuration (buf.yaml).
	// This means the module is built differently than described in storage, which
	// may cause building to fail or succeed when it shouldn't. For your own
	// sanity, you should pass a config value read from the provided bucket.
	//
	// TODO: why do we pass a config here?! This parameter should be removed.
	BuildForBucket(
		ctx context.Context,
		readBucket storage.ReadBucket,
		config *bufmoduleconfig.Config,
		options ...BuildOption,
	) (*BuiltModule, error)
}

ModuleBucketBuilder builds modules for buckets.

func NewModuleBucketBuilder

func NewModuleBucketBuilder() ModuleBucketBuilder

NewModuleBucketBuilder returns a new BucketBuilder.

type ModuleFileSetBuilder

type ModuleFileSetBuilder interface {
	Build(
		ctx context.Context,
		module bufmodule.Module,
		options ...BuildModuleFileSetOption,
	) (bufmodule.ModuleFileSet, error)
}

ModuleFileSetBuilder builds ModuleFileSets from Modules.

func NewModuleFileSetBuilder

func NewModuleFileSetBuilder(
	logger *zap.Logger,
	moduleReader bufmodule.ModuleReader,
) ModuleFileSetBuilder

NewModuleFileSetBuilder returns a new ModuleSetProvider.

type ModuleIncludeBuilder

type ModuleIncludeBuilder interface {
	// BuildForIncludes builds a module for the given includes and file paths.
	BuildForIncludes(
		ctx context.Context,
		includeDirPaths []string,
		options ...BuildOption,
	) (bufmodule.Module, error)
}

ModuleIncludeBuilder builds modules for includes.

This is used for protoc.

func NewModuleIncludeBuilder

func NewModuleIncludeBuilder(
	logger *zap.Logger,
	storageosProvider storageos.Provider,
) ModuleIncludeBuilder

NewModuleIncludeBuilder returns a new ModuleIncludeBuilder.

TODO: we should parse includeDirPaths for modules as well in theory would be nice to be able to do buf alpha protoc -I path/to/dir -I buf.build/foo/bar/v1