dotnetexecute

README

Dotnet Execute Cloud Native Buildpack

The Dotnet Execute CNB sets the start command for a given .Net Core application once it has been built by preceding buildpacks.

Integration

The Dotnet Execute CNB completes the setup of a .Net Core application built using a sequence of CNBs. As such, it will be the only non-optional CNB in that sequence and is not explicitly required by any CNB that precedes it.

It provides dotnet-execute as a dependency, but currently there's no scenario we can imagine that you would use a downstream buildpack to require this dependency. If a user likes to include some other functionality, it can be done independent of the Dotnet Execute CNB without requiring a dependency of it.

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.

Specifying a project path

To specify a project subdirectory (i.e. the directory containing your .csproj/.fsproj/.vbproj file), 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. This configuration does not apply to FDD, FDE or Self-Contained app deployments.

Documentation

Index

• func Build(buildpackYMLParser BuildpackConfigParser, configParser ConfigParser, ...) packit.BuildFunc
• func Detect(buildpackYMLParser BuildpackConfigParser, configParser ConfigParser, ...) packit.DetectFunc
• type BuildpackConfigParser
• type BuildpackYMLParser
  • func NewBuildpackYMLParser() BuildpackYMLParser
  • func (p BuildpackYMLParser) Parse(path string) (Config, error)
  • func (p BuildpackYMLParser) ParseProjectPath(path string) (string, error)
• type Config
• type ConfigParser
• type ProjectFileParser
  • func NewProjectFileParser() ProjectFileParser
  • func (p ProjectFileParser) ASPNetIsRequired(path string) (bool, error)
  • 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 RuntimeConfig
• type RuntimeConfigParser
  • func NewRuntimeConfigParser() RuntimeConfigParser
  • func (p RuntimeConfigParser) Parse(glob string) (RuntimeConfig, error)

Functions

func Build

func Build(buildpackYMLParser BuildpackConfigParser, configParser ConfigParser, logger scribe.Logger) packit.BuildFunc

func Detect

func Detect(buildpackYMLParser BuildpackConfigParser, configParser ConfigParser, projectParser ProjectParser) packit.DetectFunc

Types

type BuildpackConfigParser

type BuildpackConfigParser interface {
	ParseProjectPath(path string) (projectPath string, err error)
}

type BuildpackYMLParser

type BuildpackYMLParser struct{}

func NewBuildpackYMLParser

func NewBuildpackYMLParser() BuildpackYMLParser

func (BuildpackYMLParser) Parse

func (p BuildpackYMLParser) Parse(path string) (Config, error)

func (BuildpackYMLParser) ParseProjectPath

func (p BuildpackYMLParser) ParseProjectPath(path string) (string, error)

type Config

type Config struct {
	ProjectPath string `yaml:"project-path"`
}

type ConfigParser

type ConfigParser interface {
	Parse(glob string) (RuntimeConfig, error)
}

type ProjectFileParser

type ProjectFileParser struct{}

func NewProjectFileParser

func NewProjectFileParser() ProjectFileParser

func (ProjectFileParser) ASPNetIsRequired

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

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)
	ASPNetIsRequired(path string) (bool, error)
	NodeIsRequired(path string) (bool, error)
}

type RuntimeConfig

type RuntimeConfig struct {
	Path       string
	Version    string
	AppName    string
	Executable bool
	UsesASPNet bool
}

type RuntimeConfigParser

type RuntimeConfigParser struct{}

func NewRuntimeConfigParser

func NewRuntimeConfigParser() RuntimeConfigParser

func (RuntimeConfigParser) Parse

func (p RuntimeConfigParser) Parse(glob string) (RuntimeConfig, error)