dotnetpublish

README

Dotnet Publish Cloud Native Buildpack

The Dotnet Publish CNB requires a set of buildpacks and then compiles the application that it has been given.

Integration

The Dotnet Publish CNB provides build dependency. The build dependency can required by generating a Build Plan TOML file that looks like the following:

[[requires]]

  # The name of the Dotnet Publish dependency is "build". This value is considered
  # part of the public API for the buildpack and will not change without a plan
  # for deprecation.
  name = "build"

  # Note: The version field is unsupported as there is no version for a set of
  # build.

  # The Dotnet Publish CNB does not support non-required metadata options.

Configuration

BP_DOTNET_PROJECT_PATH

To specify a project subdirectory to be used as the root of the app, please use the BP_DOTNET_PROJECT_PATH environment variable at build time either directly (e.g. pack build my-app --env BP_DOTNET_PROJECT_PATH=./src/my-app) or through a project.toml file.

BP_DOTNET_PROJECT_PATH=./src/my-app

Usage

To package this buildpack for consumption:

$ ./scripts/package.sh

This builds the buildpack's source using GOOS=linux by default. You can supply another value as the first argument to package.sh.

Documentation

Index

• func Build(config Configuration, sourceRemover SourceRemover, ...) packit.BuildFunc
• func Detect(config Configuration, parser ProjectParser) packit.DetectFunc
• type BindingResolver
• type BuildPlanMetadata
• type Configuration
• type DotnetPublishProcess
  • func NewDotnetPublishProcess(executable Executable, logger scribe.Emitter, clock chronos.Clock) DotnetPublishProcess
  • func (p DotnetPublishProcess) Execute(workingDir, nugetCachePath, projectPath, outputPath string, debug bool, ...) error
• type DotnetSourceRemover
  • func NewDotnetSourceRemover() DotnetSourceRemover
  • func (m DotnetSourceRemover) Remove(workingDir, publishOutputDir string, excludedFiles ...string) error
• type Executable
• type OutputSlicer
  • func NewOutputSlicer() OutputSlicer
  • func (s OutputSlicer) Slice(assetsFile string) (pkgs, earlyPkgs, projects packit.Slice, err error)
• type ProjectFileParser
  • func NewProjectFileParser() ProjectFileParser
  • func (p ProjectFileParser) FindProjectFile(path string) (string, error)
  • func (p ProjectFileParser) NPMIsRequired(path string) (bool, error)
  • func (p ProjectFileParser) NodeIsRequired(path string) (bool, error)
  • func (p ProjectFileParser) ParseVersion(path string) (string, error)
• type ProjectParser
• type PublishProcess
• type SBOMGenerator
• type Slicer
• type SourceRemover
• type SymlinkManager
• type Symlinker
  • func NewSymlinker() Symlinker
  • func (s Symlinker) Link(oldname, newname string) error
  • func (s Symlinker) Unlink(path string) error

Functions

func Build

func Build(
	config Configuration,
	sourceRemover SourceRemover,
	bindingResolver BindingResolver,
	homeDir string,
	symlinker SymlinkManager,
	publishProcess PublishProcess,
	slicer Slicer,
	clock chronos.Clock,
	logger scribe.Emitter,
	sbomGenerator SBOMGenerator,
) packit.BuildFunc

func Detect

func Detect(config Configuration, parser ProjectParser) packit.DetectFunc

Types

type BindingResolver

type BindingResolver interface {
	Resolve(typ, provider, platformDir string) ([]servicebindings.Binding, error)
}

type BuildPlanMetadata

type BuildPlanMetadata struct {
	Version       string `toml:"version,omitempty"`
	VersionSource string `toml:"version-source,omitempty"`
	Build         bool   `toml:"build"`
	Launch        bool   `toml:"launch"`
}

type Configuration

type Configuration struct {
	LogLevel             string `env:"BP_LOG_LEVEL"`
	DebugEnabled         bool   `env:"BP_DEBUG_ENABLED"`
	DisableOutputSlicing bool   `env:"BP_DOTNET_DISABLE_BUILDPACK_OUTPUT_SLICING"`
	ProjectPath          string `env:"BP_DOTNET_PROJECT_PATH"`
	PublishFlags         []string
	RawPublishFlags      string `env:"BP_DOTNET_PUBLISH_FLAGS"`
}

type DotnetPublishProcess

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

func NewDotnetPublishProcess

func NewDotnetPublishProcess(executable Executable, logger scribe.Emitter, clock chronos.Clock) DotnetPublishProcess

func (DotnetPublishProcess) Execute

func (p DotnetPublishProcess) Execute(workingDir, nugetCachePath, projectPath, outputPath string, debug bool, flags []string) error

type DotnetSourceRemover

type DotnetSourceRemover struct{}

func NewDotnetSourceRemover

func NewDotnetSourceRemover() DotnetSourceRemover

func (DotnetSourceRemover) Remove

func (m DotnetSourceRemover) Remove(workingDir, publishOutputDir string, excludedFiles ...string) error

type Executable

type Executable interface {
	Execute(pexec.Execution) error
}

type OutputSlicer

type OutputSlicer struct{}

func NewOutputSlicer

func NewOutputSlicer() OutputSlicer

func (OutputSlicer) Slice

func (s OutputSlicer) Slice(assetsFile string) (pkgs, earlyPkgs, projects packit.Slice, err error)

type ProjectFileParser

type ProjectFileParser struct{}

func NewProjectFileParser

func NewProjectFileParser() ProjectFileParser

func (ProjectFileParser) FindProjectFile

func (p ProjectFileParser) FindProjectFile(path string) (string, error)

func (ProjectFileParser) NPMIsRequired

func (p ProjectFileParser) NPMIsRequired(path string) (bool, error)

func (ProjectFileParser) NodeIsRequired

func (p ProjectFileParser) NodeIsRequired(path string) (bool, error)

func (ProjectFileParser) ParseVersion

func (p ProjectFileParser) ParseVersion(path string) (string, error)

type ProjectParser

type ProjectParser interface {
	FindProjectFile(root string) (string, error)
	ParseVersion(path string) (string, error)
	NodeIsRequired(path string) (bool, error)
	NPMIsRequired(path string) (bool, error)
}

type PublishProcess

type PublishProcess interface {
	Execute(workingDir, nugetCachePath, projectPath, outputPath string, debug bool, flags []string) error
}

type SBOMGenerator

type SBOMGenerator interface {
	Generate(dir string) (sbom.SBOM, error)
}

type Slicer

type Slicer interface {
	Slice(assetsFile string) (pkgs, earlyPkgs, projects packit.Slice, err error)
}

type SourceRemover

type SourceRemover interface {
	Remove(workingDir, publishOutputDir string, excludedFiles ...string) error
}

type SymlinkManager

type SymlinkManager interface {
	Link(oldname, newname string) error
	Unlink(path string) error
}

type Symlinker

type Symlinker struct{}

func NewSymlinker

func NewSymlinker() Symlinker

func (Symlinker) Link

func (s Symlinker) Link(oldname, newname string) error

func (Symlinker) Unlink

func (s Symlinker) Unlink(path string) error