Skip to content

Commit

Permalink
readme: Update README with info about dev&test env
Browse files Browse the repository at this point in the history
Signed-off-by: Mike Sul <[email protected]>
  • Loading branch information
mike-sul committed Sep 20, 2024
1 parent dbdeec0 commit f10453c
Showing 1 changed file with 19 additions and 1 deletion.
20 changes: 19 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,4 +88,22 @@ composectl rm <app name> [<app name>] [--prune]
```
```commandline
composectl prune
```
```

## Development And Testing

The dev&test environment based on docker compose contains all required elements to build, manually test, as well as run automated tests.
To launch the environment and enter into its shell just run:
```commandline
./dev-shell.sh
```
It will take some time to start the environment for the first time because:
1. The docker daemon (dind) and the registry container (distribution) images have to be pulled.
2. The dev&test container should be built.

Once you are logged into the container shell you can build and run the `composectl` utility, test it manually
and run automated tests:
```commandline
./dev-shell.sh
make test-e2e
```

0 comments on commit f10453c

Please sign in to comment.