docker/setup-compose-action
3
0
Fork 0
mirror of https://github.com/docker/setup-compose-action.git synced 2025-04-22 07:30:02 +02:00
Code Issues Packages Projects Releases Wiki Activity

chore: readme

Browse Source
This commit is contained in:
CrazyMax 2025-01-20 12:13:47 +01:00
parent e49975c5ff
commit d86f57bae0
No known key found for this signature in database
GPG Key ID: ADE44D8C9D44FBE4
2 changed files with 54 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
.github/setup-compose-action.png vendored Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 7.8 KiB

54
README.md Normal file
View File

@ -0,0 +1,54 @@
[![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?branch=master&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?branch=master&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: 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)