GitHub Action
Spin-Up Docker Compose
v1.2
Latest version
An action to spin up your docker compose environment within GitHub Actions. Caching and Optimizing, sharing image between jobs by using localhost registry.
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Setup docker compose
uses: yu-ichiro/spin-up-docker-compose-action@v1
with:
file: compose.yml
# docker compose environment available below
file: required string
: the file to parse targets from, normally compose.yml. supported format:yaml
cache-key: string
: the cache key to use for saving build data. defaults to"default"
shared: bool
: whether to use local registry to share built images. this enablesregistry
andlocalhost
. defaults tofalse
registry: bool
: whether to use a local registry or not. defaults tofalse
localhost: bool
: whether to replace targets' registry to localhost or not.registry
must betrue
to use this. defaults tofalse
pull: bool
: whether to pull targets' images. defaults to falsepull-opts: string
: options to pass todocker compose pull
.pull
must betrue
to use this. defaults to""
bake: bool
: whether to bake targets. defaults tofalse
push: bool
: whether to push targets' images after baking.bake
must betrue
to use this. defaults tofalse
bake-opts: string
: options to pass todocker buildx bake
.bake
must betrue
to use this. defaults to""
up: bool
: whether to boot up docker compose. defaults totrue
up-opts: string
: options to pass todocker compose up
.up
must betrue
to use this. defaults to"-d"
example workflows are located in ./examples