Watch
1
0
Fork
You've already forked buildah-build
1
mirror of https://github.com/redhat-actions/buildah-build.git synced 2026-11-16 19:40:57 +00:00
buildah-build/action.yml
Christopher Brown ed0eeb94a2
Fix squash input documentation to match actual behavior (#206) (#208)
The squash input only applies to scratch (non-Containerfile) builds via
buildah commit --squash, which squashes newly added layers but preserves
base image layers. The docs incorrectly listed it as a Containerfile
build input and described it as squashing all layers.

- Remove squash from the Containerfile build inputs table in README
- Add squash to the scratch build inputs table with accurate description
- Update action.yml description to clarify scratch-only scope

Co-authored-by: Claude Opus 4.6 <[email protected]>
2026-09-16 11:39:31 +01:00

123 lines
4.7 KiB
YAML

name: 'Buildah Build'
description: 'Build a container image, with or without a Containerfile'
author: 'Red Hat'
branding:
icon: circle
color: red
inputs:
image:
description: 'The name (reference) of the image to build'
required: false
tags:
description: 'The tags of the image to build. For multiple tags, seperate by whitespace. For example, "latest v1".'
required: false
default: latest
labels:
description: 'The labels of the image to build. Seperate by newline. For example, "io.containers.capabilities=sys_admin,mknod".'
required: false
annotations:
description: 'The annotations of the image to build. Seperate by newline. For example, "org.opencontainers.image.version=1.5.6". Only supported by OCI images.'
required: false
base-image:
description: 'The base image to use to create a new container image'
required: false
containerfiles:
description: 'List of Containerfile paths (eg: ./Containerfile)'
required: false
dockerfiles:
description: 'Alias for "containerfiles". "containerfiles" takes precedence if both are set.'
required: false
context:
description: 'Path of the directory to use as context (default: .)'
required: false
default: '.'
content:
description: 'List of files/directories to copy inside the base image'
required: false
entrypoint:
description: 'The entry point to set for containers based on image'
required: false
layers:
description: 'Set to true to cache intermediate layers during build process'
required: false
port:
description: 'The port(s) to expose when running containers based on image. Separate multiple ports by newline.'
required: false
workdir:
description: 'The working directory to use within the container'
required: false
envs:
description: 'List of environment variables to be set when running containers based on image'
required: false
build-args:
description: 'List of --build-args to pass to buildah'
required: false
squash:
description: 'Scratch builds only. Set to true to squash newly added layers into a single layer. Does not affect the base image layers. Has no effect on Containerfile builds.'
default: 'true'
required: false
oci:
description: 'Set to true to build using the OCI image format instead of the Docker image format'
default: 'false'
required: false
arch:
description:
'Label the image with this ARCH, instead of defaulting to the host architecture'
required: false
archs:
description: |
'Same as input 'arch', use this for multiple architectures.
Seperate them by a comma'
required: false
platform:
description: |
Label the image with this PLATFORM, instead of defaulting to the host platform.
Only supported for containerfile builds.
required: false
platforms:
description: |
'Same as input 'platform', use this for multiple platforms.
Seperate them by a comma'
required: false
extra-args:
description: |
Extra args to be passed to buildah bud and buildah from.
Separate arguments by newline. Do not use quotes - @actions/exec will do the quoting for you.
required: false
tls-verify:
description: |
Require HTTPS and verify certificates when accessing the registry. Defaults to true.
required: false
default: 'true'
disable-fuse-overlayfs:
description: |
Set to true to prevent the action from overriding the storage mount program to fuse-overlayfs.
Modern kernels (5.11+) support rootless native overlayfs, making the override unnecessary.
The action now auto-detects kernel support and skips the override when possible, but this
input can be used to force-disable the override on older kernels or self-hosted runners.
required: false
default: 'false'
buildah-image:
description: |
Run buildah from this container image instead of using the host-installed buildah.
Useful for getting a newer buildah version than what the runner provides.
For example, "quay.io/buildah/stable" or "quay.io/buildah/upstream".
required: false
sequential:
description: |
Set to true to run builds sequentially instead of in parallel when multiple architectures or platforms are provided.
Defaults to false for backward compatibility.
required: false
default: 'false'
outputs:
image:
description: 'Name of the image built'
tags:
description: 'List of the tags that were created, separated by spaces'
image-with-tag:
description: 'Name of the image tagged with the first tag present'
digest:
description: 'Digest of the built image'
runs:
using: 'node24'
main: 'dist/index.js'