Skip to content

Commit d86f57b

Browse files
committed
chore: readme
1 parent e49975c commit d86f57b

2 files changed

Lines changed: 54 additions & 0 deletions

File tree

.github/setup-compose-action.png

7.8 KB
Loading

README.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
[![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)
2+
[![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)
3+
[![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)
4+
[![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)
5+
[![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)
6+
7+
## About
8+
9+
GitHub Action to set up Docker [Compose](https://github.com/docker/compose).
10+
11+
![Screenshot](.github/setup-compose-action.png)
12+
13+
___
14+
15+
* [Usage](#usage)
16+
* [Customizing](#customizing)
17+
* [inputs](#inputs)
18+
* [Contributing](#contributing)
19+
20+
## Usage
21+
22+
```yaml
23+
name: ci
24+
25+
on:
26+
push:
27+
28+
jobs:
29+
compose:
30+
runs-on: ubuntu-latest
31+
steps:
32+
-
33+
name: Checkout
34+
uses: actions/checkout@v4
35+
-
36+
name: Set up Docker Compose
37+
uses: docker/setup-compose-action@v1
38+
```
39+
40+
## Customizing
41+
42+
### inputs
43+
44+
The following inputs can be used as `step.with` keys:
45+
46+
| Name | Type | Default | Description |
47+
|----------------|--------|---------|---------------------------------------------------------------------------------|
48+
| `version` | String | | [Compose](https://github.com/docker/compose) version. (eg. `v2.32.4`, `latest`) |
49+
| `cache-binary` | Bool | `true` | Cache compose binary to GitHub Actions cache backend |
50+
51+
## Contributing
52+
53+
Want to contribute? Awesome! You can find information about contributing to
54+
this project in the [CONTRIBUTING.md](/.github/CONTRIBUTING.md)

0 commit comments

Comments
 (0)