mitigram/Compose Build

Build from compose file, with additional features such as changing destination registry or tag, or run pre-build and/or post-push hooks.

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stale
License
None
namedescriptionrequireddefault
composePath to the compose fileyesdocker-compose.yml
pushWhen true, images specified by the compose file will also be pushed to their respective registries, once building has finished. The `docker` client used in the workflow must have enough credentials to access the remote registries. Old images will automatically be skipped (see input `age`) notrue
builderSpecifies the builder to use, can be one of: + `compose` (the default): will try hard to use compose, but will revert to the `auto` builder (see below) when `docker-compose` is not installed. + `auto`: will pick the best of the new `buildx` or old-style `docker build`, depending on which is available, and in that order, i.e. `buildx` preferred. + `buildx`: will use the new `buildx` for building. This requires the `buildx` Docker plugin to be available and properly installed. + `docker` or `build`: will use the old-style `docker build` command. nocompose
servicesSpecifies the space separated list of services to build. These services need to exist in the compose file. When empty, the default, the action will default to building/pushing all the services specified in the compose file. no
tagsSpecifies the space separated list of tags to give to the images that will be built/pushed. When building, the image with the first tag in the list will be built, while images with the other tags will be tagged with the first image as the source. The default is to not specified any tag, in which case the tag from the compose file will be picked up and used, if any. no
registrySpecifies an alternative registry to use instead of the one specified as part of the compose file. When no registry is given, the default, the registry will be the one from the compose file. no
ageSpecifies the maximum age (in seconds) of the image since creation to decide whether it should be pushed or not. This is a safety measure to avoid pushing junk images have not been changed during build. The default of `1200` seconds should work in most cases, but any negative value will turn this check off, meaning that all relevant images will be pushed, disregarding their age. no1200
initSpecifies a list of directory paths, separated by the colon `:` sign wherefrom to find and execute initialisation actions. All exectuable (scripts or programs) in these directories will automatically be executed once the action initialisation has ended and before build and push operations are about to start. See main README.md for more information no-
cleanupSpecifies a list of directory paths, separated by the colon `:` sign wherefrom to find and execute cleanup actions. All exectuable (scripts or programs) in these directories will automatically be executed once images have been built and pushed. See main README.md for more information no-
optionsAdditional options to build implementation script, e.g. -v to print out additional verbose information. This is a semi-internal input and should only be used for debugging. If led by a double-dash, the value to this input can be used to pass further option to the build commands, e.g. `-- --no-cache`. no""
namedescription
imagesList of images that were built/pushed.