Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
ybyzek committed Jun 7, 2022
1 parent 213d8e4 commit 3064e3c
Showing 1 changed file with 30 additions and 1 deletion.
31 changes: 30 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,31 @@
Test
# cp-all-in-one-action

This action runs [cp-all-in-one](https://github.com/confluentinc/cp-all-in-one/tree/latest/cp-all-in-one), a Docker Compose for Confluent Platform. See [Confluent documentation](https://docs.confluent.io/platform/current/tutorials/build-your-own-demos.html) for details.

# Usage

- `service`: up to which service in the docker-compose.yml file to run. Default is none, so all services are run
- `github-branch-version`: which GitHub branch of [cp-all-in-one](https://github.com/confluentinc/cp-all-in-one) to run. Default is `latest`.

Example to run ZooKeeper and broker on Confluent Platform `7.1.0`:

```yaml

steps:

- name: Run Confluent Platform (Confluent Server)
uses: ./.github/actions/cp-all-in-one
with:
service: broker
github-branch-version: 7.1.0-post
```
Example to run all services on `latest`:

```yaml
steps:
- name: Run Confluent Platform (Confluent Server)
uses: ./.github/actions/cp-all-in-one
```

0 comments on commit 3064e3c

Please sign in to comment.