From f10453c74c82c0de01c91eb8436c95b65a082629 Mon Sep 17 00:00:00 2001 From: Mike Sul Date: Fri, 20 Sep 2024 12:27:19 +0200 Subject: [PATCH] readme: Update README with info about dev&test env Signed-off-by: Mike Sul --- README.md | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ecaf8e0..14bdb2d 100644 --- a/README.md +++ b/README.md @@ -88,4 +88,22 @@ composectl rm [] [--prune] ``` ```commandline composectl prune -``` \ No newline at end of file +``` + +## 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 +```