[Feature] Add support for passing --metadata-file from cli arg to buildx build #464

CHANGELOG.md

@@ -4,6 +4,10 @@ Notable changes.
 
 ## March 2023
 
+### [0.36.0]
+
+- Add `--metadata-file` argument to `devcontainer build` command, to enable exporting build info. (https://github.com/devcontainers/cli/issues/464)
+
 ### [0.35.0]
 
 - Transform maven, gradle and jupyterlab usages to their features v2 counterparts. (https://github.com/devcontainers/cli/issues/461)

package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@devcontainers/cli",
 	"description": "Dev Containers CLI",
-	"version": "0.35.0",
+	"version": "0.36.0",
 	"bin": {
 		"devcontainer": "devcontainer.js"
 	},

src/spec-common/injectHeadless.ts

@@ -60,6 +60,7 @@ export interface ResolverParameters {
 	buildxPlatform: string | undefined;
 	buildxPush: boolean;
 	buildxOutput: string | undefined;
+	buildxMetadataFile: string | undefined;
 	skipFeatureAutoMapping: boolean;
 	skipPostAttach: boolean;
 	containerSessionDataFolder?: string;

src/spec-node/devContainers.ts

@@ -52,6 +52,7 @@ export interface ProvisionOptions {
 	buildxPlatform: string | undefined;
 	buildxPush: boolean;
 	buildxOutput: string | undefined;
+	buildxMetadataFile: string | undefined;
 	additionalFeatures?: Record<string, string | boolean | Record<string, string | boolean>>;
 	skipFeatureAutoMapping: boolean;
 	skipPostAttach: boolean;
@@ -134,6 +135,7 @@ export async function createDockerParams(options: ProvisionOptions, disposables:
 		buildxPlatform: options.buildxPlatform,
 		buildxPush: options.buildxPush,
 		buildxOutput: options.buildxOutput,
+		buildxMetadataFile: options.buildxMetadataFile,
 		skipFeatureAutoMapping: options.skipFeatureAutoMapping,
 		skipPostAttach: options.skipPostAttach,
 		containerSessionDataFolder: options.containerSessionDataFolder,
@@ -182,6 +184,7 @@ export async function createDockerParams(options: ProvisionOptions, disposables:
 		buildxPlatform: common.buildxPlatform,
 		buildxPush: common.buildxPush,
 		buildxOutput: common.buildxOutput,
+		buildxMetadataFile: common.buildxMetadataFile
 	};
 }
 

src/spec-node/devContainersSpecCLI.ts

@@ -238,6 +238,7 @@ async function provision({
 		buildxPlatform: undefined,
 		buildxPush: false,
 		buildxOutput: undefined,
+		buildxMetadataFile: undefined,
 		additionalFeatures,
 		skipFeatureAutoMapping,
 		skipPostAttach,
@@ -389,6 +390,7 @@ async function doSetUp({
 			buildxPlatform: undefined,
 			buildxPush: false,
 			buildxOutput: undefined,
+			buildxMetadataFile: undefined,
 			skipFeatureAutoMapping: false,
 			skipPostAttach: false,
 			skipPersistingCustomizationsFromFeatures: false,
@@ -461,6 +463,7 @@ function buildOptions(y: Argv) {
 		'platform': { type: 'string', description: 'Set target platforms.' },
 		'push': { type: 'boolean', default: false, description: 'Push to a container registry.' },
 		'output': { type: 'string', description: 'Overrides the default behavior to load built images into the local docker registry. Valid options are the same ones provided to the --output option of docker buildx build.' },
+		'metadata-file': { type: 'string', description: 'Write build result metadata to the file. Valid options are the same ones provided to the --metadata-file option of docker buildx build. ' },
 		'additional-features': { type: 'string', description: 'Additional features to apply to the dev container (JSON as per "features" section in devcontainer.json)' },
 		'skip-feature-auto-mapping': { type: 'boolean', default: false, hidden: true, description: 'Temporary option for testing.' },
 		'skip-persisting-customizations-from-features': { type: 'boolean', default: false, hidden: true, description: 'Do not save customizations from referenced Features as image metadata' },
@@ -495,6 +498,7 @@ async function doBuild({
 	'platform': buildxPlatform,
 	'push': buildxPush,
 	'output': buildxOutput,
+	'metadata-file': buildxMetadataFile,
 	'additional-features': additionalFeaturesJson,
 	'skip-feature-auto-mapping': skipFeatureAutoMapping,
 	'skip-persisting-customizations-from-features': skipPersistingCustomizationsFromFeatures,
@@ -538,6 +542,7 @@ async function doBuild({
 			buildxPlatform,
 			buildxPush,
 			buildxOutput,
+			buildxMetadataFile,
 			skipFeatureAutoMapping,
 			skipPostAttach: true,
 			skipPersistingCustomizationsFromFeatures: skipPersistingCustomizationsFromFeatures,
@@ -786,6 +791,7 @@ async function doRunUserCommands({
 			buildxPlatform: undefined,
 			buildxPush: false,
 			buildxOutput: undefined,
+			buildxMetadataFile: undefined,
 			skipFeatureAutoMapping,
 			skipPostAttach,
 			skipPersistingCustomizationsFromFeatures: false,
@@ -1138,6 +1144,7 @@ export async function doExec({
 			buildxPush: false,
 			skipFeatureAutoMapping,
 			buildxOutput: undefined,
+			buildxMetadataFile: undefined,
 			skipPostAttach: false,
 			skipPersistingCustomizationsFromFeatures: false,
 			dotfiles: {}

src/spec-node/singleContainer.ts

@@ -205,6 +205,10 @@ async function buildAndExtendImage(buildParams: DockerResolverParameters, config
 	if (target) {
 		args.push('--target', target);
 	}
+	if(buildParams.buildxMetadataFile) {
+		output.write('Setting Metadata file: ' + buildParams.buildxMetadataFile, LogLevel.Trace);
+		args.push('--metadata-file', buildParams.buildxMetadataFile);
+	}
 	if (noCache) {
 		args.push('--no-cache');
 		// `docker build --pull` pulls local image: https://github.com/devcontainers/cli/issues/60

src/spec-node/utils.ts

@@ -115,6 +115,7 @@ export interface DockerResolverParameters {
 	buildxPlatform: string | undefined;
 	buildxPush: boolean;
 	buildxOutput: string | undefined;
+	buildxMetadataFile: string | undefined;
 }
 
 export interface ResolverResult {