https://github.com/docker/setup-compose-action

GitHub Action to set up Docker Compose
https://github.com/docker/setup-compose-action

compose docker docker-compose github-actions github-actions-docker

Last synced: about 2 months ago
JSON representation

GitHub Action to set up Docker Compose

• Host: GitHub
• URL: https://github.com/docker/setup-compose-action
• Owner: docker
• License: apache-2.0
• Created: 2025-01-20T11:58:08.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2025-04-22T12:37:23.000Z (2 months ago)
• Last Synced: 2025-04-22T13:48:12.611Z (2 months ago)
• Topics: compose, docker, docker-compose, github-actions, github-actions-docker
• Language: TypeScript
• Homepage: https://github.com/marketplace/actions/docker-setup-compose
• Size: 4.46 MB
• Stars: 15
• Watchers: 5
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md
  • Security: .github/SECURITY.md

Awesome Lists containing this project

README

        
[![GitHub release](https://img.shields.io/github/release/docker/setup-compose-action.svg?style=flat-square)](https://github.com/docker/setup-compose-action/releases/latest)

[![GitHub marketplace](https://img.shields.io/badge/marketplace-docker--setup--compose-blue?logo=github&style=flat-square)](https://github.com/marketplace/actions/docker-setup-compose)

[![CI workflow](https://img.shields.io/github/actions/workflow/status/docker/setup-compose-action/ci.yml?label=ci&logo=github&style=flat-square)](https://github.com/docker/setup-compose-action/actions?workflow=ci)

[![Test workflow](https://img.shields.io/github/actions/workflow/status/docker/setup-compose-action/test.yml?label=test&logo=github&style=flat-square)](https://github.com/docker/setup-compose-action/actions?workflow=test)

[![Codecov](https://img.shields.io/codecov/c/github/docker/setup-compose-action?logo=codecov&style=flat-square)](https://codecov.io/gh/docker/setup-compose-action)

## About

GitHub Action to set up Docker [Compose](https://github.com/docker/compose).

![Screenshot](.github/setup-compose-action.png)

___

* [Usage](#usage)

* [Customizing](#customizing)

  * [inputs](#inputs)

* [Contributing](#contributing)

## Usage

```yaml

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](https://github.com/docker/compose/releases/latest).

To always download and install the latest version of Docker Compose:

```yaml

      -

        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](https://github.com/docker/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](/.github/CONTRIBUTING.md)