Function internalGetImageBuildInfoFromDockerfile

src/spec-node/imageMetadata.ts:401–436

(inspectDockerImage: (imageName: string) => Promise<ImageDetails>, dockerfileText: string, dockerBuildArgs: Record<string, string>, targetStage: string | undefined, substitute: SubstituteConfig, output: Log, omitSyntaxDirective: boolean, buildPlatform: PlatformInfo, targetPlatform: PlatformInfo)

}

export async function internalGetImageBuildInfoFromDockerfile(inspectDockerImage: (imageName: string) => Promise<ImageDetails>, dockerfileText: string, dockerBuildArgs: Record<string, string>, targetStage: string | undefined, substitute: SubstituteConfig, output: Log, omitSyntaxDirective: boolean, buildPlatform: PlatformInfo, targetPlatform: PlatformInfo): Promise<ImageBuildInfo> {
	const dockerfile = extractDockerfile(dockerfileText);
	if (dockerfile.preamble.directives.syntax && omitSyntaxDirective) {
		output.write(`Omitting syntax directive '${dockerfile.preamble.directives.syntax}' from Dockerfile.`, LogLevel.Trace);
		delete dockerfile.preamble.directives.syntax;
	}
	// https://github.com/moby/buildkit/blob/master/frontend/dockerfile/docs/reference.md#automatic-platform-args-in-the-global-scope
	const globalBuildxPlatformArgs = {
		// platform of the node performing the build.
		BUILDPLATFORM: [buildPlatform.os, buildPlatform.arch, buildPlatform.variant].filter(Boolean).join("/"),
		// OS component of BUILDPLATFORM
		BUILDOS: buildPlatform.os,
		// architecture component of BUILDPLATFORM
		BUILDARCH: buildPlatform.arch,
		// variant component of BUILDPLATFORM
		BUILDVARIANT: buildPlatform.variant ?? "",
		// platform of the build result. Eg linux/amd64, linux/arm/v7, windows/amd64.
		TARGETPLATFORM: [targetPlatform.os, targetPlatform.arch, targetPlatform.variant].filter(Boolean).join("/"),
		// OS component of TARGETPLATFORM
		TARGETOS: targetPlatform.os,
		// architecture component of TARGETPLATFORM
		TARGETARCH: targetPlatform.arch,
		// variant component of TARGETPLATFORM
		TARGETVARIANT: targetPlatform.variant ?? "",
	};
	const baseImage = findBaseImage(dockerfile, dockerBuildArgs, targetStage, globalBuildxPlatformArgs);
	const imageDetails = baseImage && await inspectDockerImage(baseImage) || undefined;
	const dockerfileUser = findUserStatement(dockerfile, dockerBuildArgs, envListToObj(imageDetails?.Config.Env), globalBuildxPlatformArgs, targetStage);
	const user = dockerfileUser || imageDetails?.Config.User || 'root';
	const metadata = imageDetails ? getImageMetadata(imageDetails, substitute, output) : { config: [], raw: [], substitute };
	return {
		user,
		metadata,
		dockerfile,
	};
}

export const imageMetadataLabel = 'devcontainer.metadata';