Merge pull request #300 from sebst/feature/cache-from-to

Add `cacheTo` argument to `ci` action

Author: samruddhikhandale

action.yml

@@ -63,6 +63,9 @@ inputs:
     required: false
     default: false
     description: Builds the image with `--no-cache` (takes precedence over `cacheFrom`)
+  cacheTo:
+    required: false
+    description: Specify the image to cache the built image to
 outputs:
   runCmdOutput:
     description: The output of the command specified in the runCmd input

azdo-task/DevcontainersCi/src/docker.ts

@@ -12,6 +12,7 @@ export async function buildImage(
 	subFolder: string,
 	skipContainerUserIdUpdate: boolean,
 	cacheFrom: string[],
+	cacheTo: string[],
 ): Promise<string> {
 	console.log('🏗 Building dev container...');
 	try {
@@ -23,6 +24,7 @@ export async function buildImage(
 			subFolder,
 			skipContainerUserIdUpdate,
 			cacheFrom,
+			cacheTo,
 		);
 	} catch (error) {
 		task.setResult(task.TaskResult.Failed, error);

azdo-task/DevcontainersCi/src/main.ts

@@ -48,6 +48,7 @@ export async function runMain(): Promise<void> {
 		const inputEnvsWithDefaults = populateDefaults(envs, inheritEnv);
 		const cacheFrom = task.getInput('cacheFrom')?.split('\n') ?? [];
 		const noCache = (task.getInput('noCache') ?? 'false') === 'true';
+		const cacheTo = task.getInput('cacheTo')?.split('\n') ?? [];
 		const skipContainerUserIdUpdate =
 			(task.getInput('skipContainerUserIdUpdate') ?? 'false') === 'true';
 
@@ -101,6 +102,7 @@ export async function runMain(): Promise<void> {
 			additionalCacheFroms: cacheFrom,
 			output: buildxOutput,
 			noCache,
+			cacheTo,
 		};
 
 		console.log('\n\n');

azdo-task/DevcontainersCi/task.json

@@ -122,6 +122,12 @@
       "type": "boolean",
       "label": "Builds the image with `--no-cache` (takes precedence over `cacheFrom`)",
       "required": false
+    },
+    {
+      "name": "cacheTo",
+      "type": "multiLine",
+      "label": "Specify the image to cache the built image to",
+      "required": false
     }
   ],
   "outputVariables": [{

azdo-task/README.md

@@ -82,6 +82,7 @@ In the example above, the devcontainer-build-run will perform the following step
 | skipContainerUserIdUpdate | false    | For non-root Dev Containers (i.e. where `remoteUser` is specified), the action attempts to make the container user UID and GID match those of the host user. Set this to true to skip this step (defaults to false)                                              |
 | cacheFrom                 | false    | Specify additional images to use for build caching                                                                                                                                                                                                               |
 | noCache                   | false    | Builds the image with `--no-cache` (takes precedence over `cacheFrom`)                                                                                                                                                                                           |
+| cacheTo                 | false    | Specify the image to cache the built image to                                                                                                                                                                                                               |
 | platform                  | false    | Platforms for which the image should be built. If omitted, defaults to the platform of the GitHub Actions Runner. Multiple platforms should be comma separated.                                                                                                  |
 
 ## Outputs

common/src/config.ts

@@ -15,6 +15,7 @@ export interface DevContainerConfig {
 		context?: string;
 		args?: Record<string, string>;
 		cacheFrom?: string | string[];
+		cacheTo?: string | string[];
 	};
 	runArgs?: string[];
 	mounts?: string[];

common/src/dev-container-cli.ts

@@ -161,6 +161,7 @@ export interface DevContainerCliBuildArgs {
   userDataFolder?: string;
   output?: string,
   noCache?: boolean,
+  cacheTo?: string[],
 }
 async function devContainerBuild(
   args: DevContainerCliBuildArgs,
@@ -195,6 +196,11 @@ async function devContainerBuild(
       commandArgs.push('--cache-from', cacheFrom),
     );
   }
+  if (args.cacheTo) {
+    args.cacheTo.forEach(cacheTo =>
+      commandArgs.push('--cache-to', cacheTo),
+    );
+  }
   return await runSpecCliJsonCommand<DevContainerCliBuildResult>({
     args: commandArgs,
     log,
@@ -211,6 +217,7 @@ export interface DevContainerCliUpArgs {
   workspaceFolder: string;
   configFile: string | undefined;
   additionalCacheFroms?: string[];
+  cacheTo?: string[];
   skipContainerUserIdUpdate?: boolean;
   env?: string[];
   userDataFolder?: string;
@@ -235,6 +242,11 @@ async function devContainerUp(
       commandArgs.push('--cache-from', cacheFrom),
     );
   }
+  if (args.cacheTo) {
+    args.cacheTo.forEach(cacheTo =>
+      commandArgs.push('--cache-to', cacheTo),
+    );
+  }
   if (args.userDataFolder) {
     commandArgs.push("--user-data-folder", args.userDataFolder);
   }

common/src/docker.ts

@@ -21,6 +21,7 @@ export async function buildImage(
 	subFolder: string,
 	skipContainerUserIdUpdate: boolean,
 	cacheFrom: string[],
+	cacheTo: string[],
 ): Promise<string> {
 	const folder = path.join(checkoutPath, subFolder);
 	const devcontainerJsonPath = path.join(
@@ -37,6 +38,7 @@ export async function buildImage(
 		folder,
 		devcontainerConfig,
 		cacheFrom,
+		cacheTo,
 	);
 
 	if (!devcontainerConfig.remoteUser || skipContainerUserIdUpdate == true) {
@@ -61,6 +63,7 @@ async function buildImageBase(
 	folder: string,
 	devcontainerConfig: config.DevContainerConfig,
 	cacheFrom: string[],
+	cacheTo: string[],
 ): Promise<void> {
 	const configDockerfile = config.getDockerfile(devcontainerConfig);
 	if (!configDockerfile) {
@@ -85,8 +88,14 @@ async function buildImageBase(
 		);
 	}
 	cacheFrom.forEach(cacheValue => args.push('--cache-from', cacheValue));
-	args.push('--cache-to');
-	args.push('type=inline');
+	if (cacheTo) {
+		coerceToArray(cacheTo).forEach(cacheValue =>
+			args.push('--cache-to', cacheValue),
+		);
+	} else {
+		args.push('--cache-to');
+		args.push('type=inline');
+	}
 	args.push('--output=type=docker');
 
 	const buildArgs = devcontainerConfig.build?.args;

docs/azure-devops-task.md

@@ -82,6 +82,7 @@ In the example above, the devcontainer-build-run will perform the following step
 | skipContainerUserIdUpdate | false    | For non-root Dev Containers (i.e. where `remoteUser` is specified), the action attempts to make the container user UID and GID match those of the host user. Set this to true to skip this step (defaults to false)                                              |
 | cacheFrom                 | false    | Specify additional images to use for build caching                                                                                                                                                                                                               |
 | noCache                   | false    | Builds the image with `--no-cache` (takes precedence over `cacheFrom`)                                                                                                                                                                                           |
+| cacheTo                 | false    | Specify the image to cache the built image to                                                                                                                                                                                                               |
 | platform                  | false    | Platforms for which the image should be built. If omitted, defaults to the platform of the GitHub Actions Runner. Multiple platforms should be comma separated.                                                                                                  |
 
 ## Outputs

docs/github-action.md

@@ -141,6 +141,7 @@ The [`devcontainers/ci` action](https://github.com/marketplace/actions/devcontai
 | skipContainerUserIdUpdate | false    | For non-root Dev Containers (i.e. where `remoteUser` is specified), the action attempts to make the container user UID and GID match those of the host user. Set this to true to skip this step (defaults to false)                            |
 | cacheFrom                 | false    | Specify additional images to use for build caching                                                                                                                                                                                             |
 | noCache                   | false    | Builds the image with `--no-cache` (takes precedence over `cacheFrom`)                                                                                                                                                                         |
+| cacheTo                 | false    | Specify the image to cache the built image to                                                                                                                                                                                             |
 | platform                  | false    | Platforms for which the image should be built. If omitted, defaults to the platform of the GitHub Actions Runner. Multiple platforms should be comma separated.                                                                                |
 
 ## Outputs