Add support for 'platform' parameter (#75)

Signed-off-by: James Addison <jay@jp-hosting.net>

src/buildah.ts

@@ -15,12 +15,13 @@ export interface BuildahConfigSettings {
     port?: string;
     workingdir?: string;
     arch?: string;
+    platform?: string;
 }
 
 interface Buildah {
     buildUsingDocker(
         image: string, context: string, containerFiles: string[], buildArgs: string[],
-        useOCI: boolean, arch: string, layers: string, extraArgs: string[]
+        useOCI: boolean, arch: string, platform: string, layers: string, extraArgs: string[]
     ): Promise<CommandResult>;
     from(baseImage: string): Promise<CommandResult>;
     config(container: string, setting: BuildahConfigSettings): Promise<CommandResult>;
@@ -63,13 +64,17 @@ export class BuildahCli implements Buildah {
 
     async buildUsingDocker(
         image: string, context: string, containerFiles: string[], buildArgs: string[],
-        useOCI: boolean, arch: string, layers: string, extraArgs: string[]
+        useOCI: boolean, arch: string, platform: string, layers: string, extraArgs: string[]
     ): Promise<CommandResult> {
         const args: string[] = [ "bud" ];
         if (arch) {
             args.push("--arch");
             args.push(arch);
         }
+        if (platform) {
+            args.push("--platform");
+            args.push(platform);
+        }
         containerFiles.forEach((file) => {
             args.push("-f");
             args.push(file);
@@ -135,6 +140,10 @@ export class BuildahCli implements Buildah {
             args.push("--arch");
             args.push(settings.arch);
         }
+        if (settings.platform) {
+            args.push("--platform");
+            args.push(settings.platform);
+        }
         if (settings.workingdir) {
             args.push("--workingdir");
             args.push(settings.workingdir);

src/generated/inputs-outputs.ts

@@ -85,6 +85,12 @@ export enum Inputs {
      * Default: "false"
      */
     OCI = "oci",
+    /**
+     * Label the image with this PLATFORM, instead of defaulting to the host platform.
+     * Required: false
+     * Default: None.
+     */
+    PLATFORM = "platform",
     /**
      * The port to expose when running containers based on image
      * Required: false

src/index.ts

@@ -9,7 +9,7 @@ import * as path from "path";
 import { Inputs, Outputs } from "./generated/inputs-outputs";
 import { BuildahCli, BuildahConfigSettings } from "./buildah";
 import {
-    getArch, getContainerfiles, getInputList, splitByNewline,
+    getArch, getPlatform, getContainerfiles, getInputList, splitByNewline,
     isFullImageName, getFullImageName,
 } from "./utils";
 
@@ -54,12 +54,17 @@ export async function run(): Promise<void> {
     const useOCI = core.getInput(Inputs.OCI) === "true";
 
     const arch = getArch();
+    const platform = getPlatform();
+
+    if (arch && platform) {
+        throw new Error("The --platform option may not be used in combination with the --arch option.");
+    }
 
     if (containerFiles.length !== 0) {
-        await doBuildUsingContainerFiles(cli, newImage, workspace, containerFiles, useOCI, arch);
+        await doBuildUsingContainerFiles(cli, newImage, workspace, containerFiles, useOCI, arch, platform);
     }
     else {
-        await doBuildFromScratch(cli, newImage, useOCI, arch);
+        await doBuildFromScratch(cli, newImage, useOCI, arch, platform);
     }
 
     if (tagsList.length > 1) {
@@ -71,7 +76,8 @@ export async function run(): Promise<void> {
 }
 
 async function doBuildUsingContainerFiles(
-    cli: BuildahCli, newImage: string, workspace: string, containerFiles: string[], useOCI: boolean, arch: string
+    cli: BuildahCli, newImage: string, workspace: string, containerFiles: string[], useOCI: boolean, arch: string,
+    platform: string
 ): Promise<void> {
     if (containerFiles.length === 1) {
         core.info(`Performing build from Containerfile`);
@@ -94,12 +100,12 @@ async function doBuildUsingContainerFiles(
         buildahBudExtraArgs = lines.flatMap((line) => line.split(" ")).map((arg) => arg.trim());
     }
     await cli.buildUsingDocker(
-        newImage, context, containerFileAbsPaths, buildArgs, useOCI, arch, layers, buildahBudExtraArgs
+        newImage, context, containerFileAbsPaths, buildArgs, useOCI, arch, platform, layers, buildahBudExtraArgs
     );
 }
 
 async function doBuildFromScratch(
-    cli: BuildahCli, newImage: string, useOCI: boolean, arch: string
+    cli: BuildahCli, newImage: string, useOCI: boolean, arch: string, platform: string
 ): Promise<void> {
     core.info(`Performing build from scratch`);
 
@@ -119,6 +125,7 @@ async function doBuildFromScratch(
         workingdir: workingDir,
         envs,
         arch,
+        platform,
     };
     await cli.config(containerId, newImageConfig);
     await cli.copy(containerId, content);

src/utils.ts

@@ -81,6 +81,10 @@ export function getArch(): string {
     return arch || archs;
 }
 
+export function getPlatform(): string {
+    return core.getInput(Inputs.PLATFORM);
+}
+
 export function getContainerfiles(): string[] {
     // 'containerfile' should be used over 'dockerfile',
     // see https://github.com/redhat-actions/buildah-build/issues/57