build

Build an image. The existing async context will be used.

@syncify
async def build(
    image: Image,
    dry_run: bool = False,
    force: bool = False,
    wait: bool = True,
) -> ImageBuild: ...

Build an image. The existing async context will be used.

Parameters

Name	Type	Description
image	Image	The image(s) to build.
dry_run	bool = False	Tell the builder to not actually build. Different builders will have different behaviors.
force	bool = False	Skip the existence check and force a rebuild. When using the remote builder, this also sets overwrite_cache=True on the build run.
wait	bool = True	Wait for the build to finish. If wait is False, the function will return immediately and the build will run in the background.

Returns

Type	Description
ImageBuild	An ImageBuild object with the image URI and remote run (if applicable).