From 524995d2e1b8076429b6a02af8d48a3eab609851 Mon Sep 17 00:00:00 2001 From: divyansh42 Date: Thu, 11 Nov 2021 19:24:40 +0530 Subject: [PATCH] Update README Signed-off-by: divyansh42 --- README.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index cf32664..eb67caa 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,9 @@ After building your image, use [push-to-registry](https://github.com/redhat-acti | Input Name | Description | Default | | ---------- | ----------- | ------- | | arch | Label the image with this architecture, instead of defaulting to the host architecture. Refer to [Multi arch builds](#multi-arch-builds) for more information. | None (host architecture) +| archs | Same as input `arch`, use this for multiple architectures. Seperate them by a comma | None (host architecture) | platform | Label the image with this platform, instead of defaulting to the host platform. Refer to [Multi arch builds](#multi-arch-builds) for more information. | None (host platform) +| platforms | Same as input `platform`, use this for multiple platforms. Seperate them by a comma | None (host platform) | build-args | Build arguments to pass to the Docker build using `--build-arg`, if using a Containerfile that requires ARGs. Use the form `arg_name=arg_value`, and separate arguments with newlines. | None | context | Path to directory to use as the build context. | `.` | containerfiles\* | The list of Containerfile paths to perform a build using docker instructions. Separate filenames by newline. | **Required** @@ -46,6 +48,7 @@ After building your image, use [push-to-registry](https://github.com/redhat-acti | Input Name | Description | Default | | ---------- | ----------- | ------- | | arch | Label the image with this architecture, instead of defaulting to the host architecture. Refer to [Multi arch builds](#multi-arch-builds) for more information. | None (host architecture) +| archs | Same as input `arch`, use this for multiple architectures. Seperate them by a comma | None (host architecture) | base-image | The base image to use for the container. | **Required** | content | Paths to files or directories to copy inside the container to create the file image. This is a multiline input to allow you to copy multiple files/directories.| None | entrypoint | The entry point to set for the container. Separate arguments by newline. | None @@ -203,11 +206,10 @@ The `arch` and `platform` arguments override the Architecture and Platform label There is a simple example [in this issue](https://github.com/redhat-actions/buildah-build/issues/60#issuecomment-876552452). ### Creating a Multi-Arch Image List -Use the [buildah manifest](https://github.com/containers/buildah/blob/main/docs/buildah-manifest.1.md) command to bundle images into an image list, so multiple image can be referenced by the same repository tag. +Input `archs` and `platforms` is provided to build the multi architecture images. If one of these input is provided then a manifest is built with the multiple architecture images. Name of the manifest is taken from the inputs `image` and `tags`. +Incase multiple tags are provided then multiple manifest is created based on the provided tags. -There are examples and explanations of the `manifest` command [in this issue](https://github.com/containers/buildah/issues/1590). - -This action does not support the `manifest` command at this time, but there is [an issue open](https://github.com/redhat-actions/buildah-build/issues/61). +[`push-to-registry`](https://github.com/redhat-actions/push-to-registry) action can be used to push the generated manifest. ## Build with docker/metadata-action