mirror of
https://github.com/docker/setup-compose-action.git
synced 2025-04-19 22:20:03 +02:00
55 lines
2.1 KiB
Markdown
55 lines
2.1 KiB
Markdown
[](https://github.com/docker/setup-compose-action/releases/latest)
|
|
[](https://github.com/marketplace/actions/docker-setup-compose)
|
|
[](https://github.com/docker/setup-compose-action/actions?workflow=ci)
|
|
[](https://github.com/docker/setup-compose-action/actions?workflow=test)
|
|
[](https://codecov.io/gh/docker/setup-compose-action)
|
|
|
|
## About
|
|
|
|
GitHub Action to set up Docker [Compose](https://github.com/docker/compose).
|
|
|
|
|
|
|
|
___
|
|
|
|
* [Usage](#usage)
|
|
* [Customizing](#customizing)
|
|
* [inputs](#inputs)
|
|
* [Contributing](#contributing)
|
|
|
|
## Usage
|
|
|
|
```yaml
|
|
name: ci
|
|
|
|
on:
|
|
push:
|
|
|
|
jobs:
|
|
compose:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
-
|
|
name: Checkout
|
|
uses: actions/checkout@v4
|
|
-
|
|
name: Set up Docker Compose
|
|
uses: docker/setup-compose-action@v1
|
|
```
|
|
|
|
## 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)
|