Buildkit - Build & Push Action

A minimally opinionated GitHub action for BuildKit's buildctl.

Requirements

• BuildKit's buildctl ~=v0.15.1 has to be available in the path of the action runner, e.g. act-buildkit-runner.

Inputs

Name	Required	Type	Description	Example
debug	No	Boolean	Enable debug output in logs	false
addr	Yes	String	Buildkitd address	tcp://buildkitd:1234
log_format	No	String	Log formatter: json or text	text
tlsdir	No	String	Directory containing CA certificate, client certificate, and client key	/path/to/tls-data
output	Yes	String	Define exports for build result. name= may be left out if tags are provided.	type=image,name=ghcr.io/${{ github.repository }}:latest,ghcr.io/${{ github.repository }}:stable,push=true
progress	No	String	Set type of progress (auto, plain, tty, rawjson)	auto
local	Yes	List	Allow build access to the local directory	local: |  context=.  dockerfile=.
frontend	No	String	Define frontend used for build	dockerfile.v0
opt	No	List	Define custom options for frontend	opt: |  filename=Dockerfile  platform=linux/amd64
no_cache	No	Boolean	Disable cache for all the vertices	true
export-cache	No	String	Export build cache	type=registry,ref=ghcr.io/${{ github.repository }}:buildcache,mode=max,push=true
import-cache	No	String	Import build cache	type=registry,ref=ghcr.io/${{ github.repository }}:buildcache
secret	No	List	Secret value exposed to the build	secret: |  id=foo,src=/path/to/foo  id=bar,src=/path/to/bar
registry-auth-tls-context	No	String	Overwrite TLS configuration when authenticating with registries	host=https://myserver:2376,insecure=false,ca=/path/to/my/ca.crt,cert=/path/to/my/cert.crt,key=/path/to/my/key.crt
tags	Yes	List	Image tags extending the names used in the output input	tags: |  {{ github.repository }}:sha-ca56cb6  {{ github.repository }}:latest
dryrun	No	Boolean	Only print the resulting buildctl command but do not actually execute it	false

Example usage

When pushing the built image make sure to have authenticated with the registry using e.g. docker/login-action in a step before.

name: Example
on:
  push
jobs:
  build:
    runs-on: ubuntu-22.04
    container:
      image: ghcr.io/omniproc/act-buildkit-runner:1.0.0
    steps: 
    - name: oci metadata
      id: meta
      uses: docker/metadata-action@v5
      with:
        images: |
          ghcr.io/${{ github.repository }}
        tags: |
          type=sha,event=branch
          type=raw,value=latest,enable={{is_default_branch}}
    - name: oci build
      uses: omniproc/[email protected]
      with:
          tags: ${{ steps.meta.outputs.tags }}
          addr: 'tcp://buildkitd:1234'
          output: 'type=image,push=false'

Development

# When a new version of this action is ready, use ncc to bundle it.
ncc build src/index.js --license licenses.txt
# Add everything to Git and tag the commit. The tag will be used as action version.
git add .
git commit -m "Release vX.x"
git tag -a -m "Release vX.x" vX.x
git push --follow-tags