dotnetcoresdk

README

.NET Core SDK Cloud Native Buildpack

The .NET Core SDK CNB provides a version of the .NET Core SDK and a version of the .NET Core Driver or the dotnet binary. It also sets the .NET Core SDK on the$DOTNET_ROOT so that it is available to subsequent buildpacks during their build phase and sets the .NET Core Driver on the $PATH so that is available to subsequent buildpacks and in the final running container.

Integration

The .NET Core SDK CNB provides the dotnet-sdk as a dependency. Downstream buildpacks, like .NET Core Build can require the dotnet-sdk dependency by generating a Build Plan TOML file that looks like the following:

[[requires]]

  # The name of the .NET Core SDK dependency is "dotnet-sdk". This value is considered
  # part of the public API for the buildpack and will not change without a plan
  # for deprecation.
  name = "dotnet-sdk"

  # The version of the .NET Core SDK dependency is not required. In the case it
  # is not specified, the buildpack will provide the default version, which can
  # be seen in the buildpack.toml file.
  # If you wish to request a specific version, the buildpack supports
  # specifying a semver constraint in the form of "3.*", "3.1.*", or even
  # "3.1.100".
  version = "3.1.100"

  # The .NET Core SDK buildpack supports some non-required metadata options.
  [requires.metadata]

    # Setting the build flag to true will ensure that the .NET Core SDK
    # depdendency is available in the $DOTNET_ROOT for subsequent buildpacks during
    # their build phase and ensures that the .NET Core Driver dependency is available
    # in the $PATH for subsequent buildpacks. If you are writing a buildpack that needs
    # to use the dotnet sdk & driver during its build process, this flag should be set
    # to true.
    build = true

Usage

To package this buildpack for consumption:

$ ./scripts/package.sh

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

(Deprecated) buildpack.yml Configurations

dotnet-sdk:
  # this allows you to specify a version constaint for the dotnet-sdk dependency
  # any valid semver constaints (e.g. 2.* and 2.1.*) are also acceptable
  version: "2.1.804"

This configuration option will be deprecated with the next major version release of the buildpack. Because the versions of the .NET Core runtime and .NET Core SDK are so tightly coupled, most users should instead use the $BP_DOTNET_FRAMEWORK_VERSION environment variable to specify which version of the .NET Core runtime that the Paketo .NET Core Runtime Buildpack should install. This buildpack will automatically select an SDK version to install that is compatible with the selected .NET Core runtime version.

Documentation

Index

• Constants
• Variables
• func Build(entryResolver EntryResolver, dependencyMapper DependencyMapper, ...) packit.BuildFunc
• func Detect(buildpackYMLParser BuildpackYMLParser) packit.DetectFunc
• type BuildpackYMLParser
• type DependencyManager
• type DependencyMapper
• type DotnetSymlinker
• type EntryResolver
• type RuntimeToSdks
• type SBOMGenerator
• type SDKVersionMapper
  • func NewSDKVersionMapper(logger scribe.Emitter) SDKVersionMapper
  • func (r SDKVersionMapper) FindCorrespondingVersion(path, versionKey string) (string, error)
• type SdkVersionParser
  • func NewSdkVersionParser() SdkVersionParser
  • func (p SdkVersionParser) Parse(workingDir string) (string, error)
• type Symlinker
  • func NewSymlinker() Symlinker
  • func (s Symlinker) Link(workingDir, layerPath string) error

Constants

const (
	DotnetDependency = "dotnet-sdk"
)

Variables

var Priorities = []interface{}{
	"RUNTIME_VERSION",
	"buildpack.yml",
	"global.json",
	"runtimeconfig.json",
	"",
}

Functions

func Build

func Build(entryResolver EntryResolver,
	dependencyMapper DependencyMapper,
	dependencyManager DependencyManager,
	dotnetSymlinker DotnetSymlinker,
	sbomGenerator SBOMGenerator,
	logger scribe.Emitter,
	clock chronos.Clock,
) packit.BuildFunc

func Detect

func Detect(buildpackYMLParser BuildpackYMLParser) packit.DetectFunc

Types

type BuildpackYMLParser

type BuildpackYMLParser interface {
	Parse(workingDir string) (string, error)
}

type DependencyManager

type DependencyManager interface {
	Resolve(path, id, version, stack string) (postal.Dependency, error)
	Deliver(dependency postal.Dependency, cnbPath, layerPath, platformPath string) error
	GenerateBillOfMaterials(dependencies ...postal.Dependency) []packit.BOMEntry
}

type DependencyMapper

type DependencyMapper interface {
	FindCorrespondingVersion(path, versionKey string) (string, error)
}

type DotnetSymlinker

type DotnetSymlinker interface {
	Link(workingDir, layerPath string) error
}

type EntryResolver

type EntryResolver interface {
	Resolve(name string, entries []packit.BuildpackPlanEntry, priorites []interface{}) (packit.BuildpackPlanEntry, []packit.BuildpackPlanEntry)
	MergeLayerTypes(name string, entries []packit.BuildpackPlanEntry) (launch, build bool)
}

type RuntimeToSdks

type RuntimeToSdks struct {
	RuntimeVersion string   `toml:"runtime-version"`
	SDKs           []string `toml:"sdks"`
}

type SBOMGenerator

type SBOMGenerator interface {
	GenerateFromDependency(dependency postal.Dependency, dir string) (sbom.SBOM, error)
}

type SDKVersionMapper

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

func NewSDKVersionMapper

func NewSDKVersionMapper(logger scribe.Emitter) SDKVersionMapper

func (SDKVersionMapper) FindCorrespondingVersion

func (r SDKVersionMapper) FindCorrespondingVersion(path, versionKey string) (string, error)

type SdkVersionParser

type SdkVersionParser struct{}

func NewSdkVersionParser

func NewSdkVersionParser() SdkVersionParser

func (SdkVersionParser) Parse

func (p SdkVersionParser) Parse(workingDir string) (string, error)

type Symlinker

type Symlinker struct{}

func NewSymlinker

func NewSymlinker() Symlinker

func (Symlinker) Link

func (s Symlinker) Link(workingDir, layerPath string) error