mirror of
https://github.com/docker/setup-compose-action.git
synced 2026-03-30 18:59:27 +00:00
GitHub Action to set up Docker Compose
112d3e30db
Some checks failed
test / test (push) Has been cancelled
validate / prepare (push) Has been cancelled
validate / validate (push) Has been cancelled
ci / main (latest) (push) Has been cancelled
ci / main (v2.32.4) (push) Has been cancelled
ci / multi (push) Has been cancelled
ci / main () (push) Has been cancelled
ci / main (cloud:latest) (push) Has been cancelled
ci / main (cloud:v2.29.1-desktop.2) (push) Has been cancelled
ci / standalone (push) Has been cancelled
ci / cache-binary (false) (push) Has been cancelled
ci / cache-binary (true) (push) Has been cancelled
node 24 as default runtime |
||
|---|---|---|
| .github | ||
| __tests__ | ||
| dist | ||
| src | ||
| .dockerignore | ||
| .editorconfig | ||
| .gitattributes | ||
| .gitignore | ||
| .prettierignore | ||
| .prettierrc.json | ||
| .yarnrc.yml | ||
| action.yml | ||
| codecov.yml | ||
| dev.Dockerfile | ||
| docker-bake.hcl | ||
| eslint.config.mjs | ||
| LICENSE | ||
| package.json | ||
| README.md | ||
| tsconfig.json | ||
| vitest.config.ts | ||
| yarn.lock | ||
About
GitHub Action to set up Docker Compose.
Usage
name: ci
on:
push:
jobs:
compose:
runs-on: ubuntu-latest
steps:
-
name: Set up Docker Compose
uses: docker/setup-compose-action@v1
Note
If Docker Compose is already installed on the runner, the action will skip download. Otherwise, it will download and install the latest stable version available on GitHub.
To always download and install the latest version of Docker Compose:
-
name: Set up Docker Compose
uses: docker/setup-compose-action@v1
with:
version: latest
Customizing
inputs
The following inputs can be used as step.with keys:
| Name | Type | Default | Description |
|---|---|---|---|
version |
String | Compose version. (eg. v2.32.4, latest) |
|
cache-binary |
Bool | true |
Cache compose binary to GitHub Actions cache backend |
Contributing
Want to contribute? Awesome! You can find information about contributing to this project in the CONTRIBUTING.md