@flowwright/plugin-docker

Ship container images without the boilerplate — a FlowWright shared library of Docker build/push stages with registry login, labels, multi-platform builds via BuildKit/buildx, and digest output all wired up for you.

import { pipeline, group } from "@flowwright/core";
import { dockerStages } from "@flowwright/plugin-docker";

export default pipeline({
  name: "api",
  stages: [
    ...group("img", dockerStages({
      image: "ghcr.io/acme/api",
      tag: "v1",
      login: { registry: "ghcr.io" },        // docker login before build
      labels: { "org.opencontainers.image.source": "acme/api" },
      platforms: ["linux/amd64", "linux/arm64"], // multi-platform → buildx, pushed directly
      push: true,
      digest: true,                           // --iidfile → uploaded as an artifact
    })),
  ],
});

| Option | Default | Notes | |---|---|---| | image | — | required image name (include the registry host if not Docker Hub) | | tag | latest | | | extraTags | — | additional -t <image>:<tag> refs; pushed too on classic builds | | target | — | multi-stage build target (--target) | | pull | false | always attempt to pull newer base images (--pull) | | cacheFrom / cacheTo | — | buildx build cache (--cache-from / --cache-to); imply buildx | | context | . | build context | | dockerfile | Dockerfile | | | buildArgs | — | --build-arg key/value pairs | | labels | — | --label key/value pairs | | platforms | — | --platform targets; implies buildx (multi-platform must be pushed) | | buildx | false | use docker buildx build (auto-enabled by platforms) | | push | false | classic build → separate push stage; buildx → folded in via --push | | login | — | add a docker login stage; true or { credential?, registry? } | | digest | — | --iidfile <path> + artifact upload; true uses image.digest | | needs | — | dependencies for the build stage |

Stage ids are docker-login / docker-build / docker-push. dockerStages returns the login/build/push stages that apply; dockerBuild returns just the build stage for composition.

Registry auth

The login stage binds a username/password credential (default id docker-registry) as DOCKER_USERNAME / DOCKER_PASSWORD and runs docker login --password-stdin. Credentials are resolved by the server/worker — the local flow run does not inject them, so run docker login yourself when building locally.

dockerBuild does not take push or login

Those options exist to produce the login and push stages, so a build-only helper cannot honor them — and under buildx, push changes the build argv itself, so dropping it would hand back an image that cannot be published. Passing either throws; use dockerStages() when you need them.

needs is applied to whichever stage heads the chain: docker-login when login is set, otherwise docker-build.