vsdbg

README

Cloud Native Buildpack for Visual Studio Debugger

The Cloud Native Buildpack for Visual Studio Debugger provides the vsdbg binary and sets it on the $PATH so that it may be invoked by subsequent buildpacks or in the final running container.

Integration

The CNB for Visual Studio Debugger provides vsdbg as a dependency. Downstream buildpacks, like the .NET Execute CNB, can require the vsdbg dependency by generating a Build Plan TOML that resembles the following:

[[requires]]

  # The name of the Visual Studio Debugger dependency is "vsdbg". This value is considered
  # part of the public API for the buildpack and will not change without a plan
  # for deprecation.
  name = "vsdbg"

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

    # Setting the launch flag to true will ensure that the Visual Studio
    # Debugger depdendency is available in the container at runtime. If you are
    # writing a buildpack that requires the presence of vsdbg at runtime, this
    # flag should be set to true.
    launch = true

The .NET Core language family buildpack supports the inclusion of vsdbg in a final image through the BP_DEBUG_ENABLED environment variable.

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.

Documentation

Index

• Constants
• func Build(dependencyManager DependencyManager, sbomGenerator SBOMGenerator, ...) packit.BuildFunc
• func Detect() packit.DetectFunc
• type DependencyManager
• type SBOMGenerator

Constants

const (
	PlanDependencyVSDBG = "vsdbg"
)

Functions

func Build

func Build(
	dependencyManager DependencyManager,
	sbomGenerator SBOMGenerator,
	logger scribe.Emitter,
	clock chronos.Clock,
) packit.BuildFunc

func Detect

func Detect() packit.DetectFunc

Types

type DependencyManager

type DependencyManager interface {
	Resolve(path, id, version, stack string) (postal.Dependency, error)
	Deliver(dependency postal.Dependency, cnbPath, destinationPath, platformPath string) error
}

DependencyManager defines the interface for picking the best matching dependency and installing it.

type SBOMGenerator

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