From 6825da107125eb320158901ec440582500905e4a Mon Sep 17 00:00:00 2001 From: Yufei Gu Date: Fri, 2 Aug 2024 13:35:16 -0700 Subject: [PATCH] Suggest docker version --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 36c775bff..60e2dbafb 100644 --- a/README.md +++ b/README.md @@ -52,7 +52,7 @@ docker run -p 8080:80 -v ${PWD}:/spec docker.io/redocly/cli build-docs spec/inde - Java JDK >= 21, see [CONTRIBUTING.md](./CONTRIBUTING.md#java-version-requirements). - Gradle - This is included in the project and can be run using `./gradlew` in the project root. -- Docker - If you want to run the project in a containerized environment. +- Docker (Suggested Version: 27+) - If you want to run the project in a containerized environment or run integration tests. Command-Line getting started ------------------- @@ -63,6 +63,7 @@ Polaris is a multi-module project with three modules: - `polaris-eclipselink` - The Eclipselink implementation of the MetaStoreManager interface Build the binary (first time may require installing new JDK version). This build will run IntegrationTests by default. +Make sure docker is running, as the integration tests require a running docker daemon. ``` ./gradlew build