README.md

About

GitHub Action to set up Docker Compose.

---

• Usage
• Customizing
  • inputs
• Contributing

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