docker-tools icon indicating copy to clipboard operation
docker-tools copied to clipboard

Add a `buildContext` option to Platform in Manifest

Open lbussell opened this issue 11 months ago • 1 comments

By default, ImageBuilder uses an explicit build context of the Dockerfile's location:

https://github.com/dotnet/docker-tools/blob/14b1496d071432e9776c93ad637479371bfec6c9/src/Microsoft.DotNet.ImageBuilder/src/ViewModel/PlatformInfo.cs#L59-L62

In some cases it's desirable to access content from outside the Dockerfile's directory. For example, when building .NET projects, you may need to access a Directory.Build.Props or NuGet.config located in a parent directory.

There are two ideas I came up with for implementing this:

Option 1: explicit path

This option would allow you to set the explicit path to the build context. The path would be relative to the manifest.

{
  "dockerfile": "src/ImageBuilder/Dockerfile.linux",
  "buildContext": "path/to/my/preferred/context",
  "os": "linux",
  "osVersion": "azurelinux",
  "tags": {
    "linux-amd64": {},
    "linux-amd64-$(UniqueId)": {}
  }
},

Option 2: limited choices

The other option would allow you to choose between having the build context be the Dockerfile's parent directory (the default, today) or the manifest's parent directory. This could be via an enum:

{
  "dockerfile": "src/ImageBuilder/Dockerfile.linux",
  "buildContext": "Manifest", // OR "Dockerfile"
  "os": "linux",
  "osVersion": "azurelinux",
  "tags": {
    "linux-amd64": {},
    "linux-amd64-$(UniqueId)": {}
  }
},

Or a boolean:

{
  "dockerfile": "src/ImageBuilder/Dockerfile.linux",
  "manifestRelativeBuildContext": "true", // "false" is the default
  "os": "linux",
  "osVersion": "azurelinux",
  "tags": {
    "linux-amd64": {},
    "linux-amd64-$(UniqueId)": {}
  }
},

lbussell avatar Feb 12 '25 19:02 lbussell

[Triage] The driver for this work is #1430. This is needed when combining projects into one solution file. Without it we can't utilize any Directory.Build.props or Directory.Packages.props files to share things between projects.

lbussell avatar Feb 24 '25 19:02 lbussell