Add note to building.md for avoid build error which caused by proto-s…

…chema-compatibility-maven-plugin check Closes keycloak#35846 Signed-off-by: Tetsuhiro Hiruta <[email protected]>
pedroigor · Dec 12, 2024 · 8d934de · 8d934de
1 parent 8e13e76
commit 8d934de
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/docs/building.md b/docs/building.md
@@ -47,6 +47,16 @@ To enable it by default, add it to the `MAVEN_OPTS` environment variable:
 
     export MAVEN_OPTS="-Dmaven.build.cache.enabled=true"
 
+---
+**NOTE**
+
+To ensure that development in a branch does not break compatibility with existing releases, proto-schema-compatibility-maven-plugin checks may be run, which can cause builds to fail in proxy environments.
+To avoid this, you can skip this check by adding the following property:
+
+    -DskipProtoLock=true
+
+---
+
 ### Starting Keycloak
 
 To start Keycloak during development first build as specified above, then run: