project: document more binary issues incompatibilities

for OwnEnv and OwnExecutionEnv
etorreborre · Jan 21, 2024 · 34584de · 34584de
1 parent c9048b6
commit 34584de
Showing 1 changed file with 7 additions and 1 deletion.
diff --git a/build.sbt b/build.sbt
@@ -114,7 +114,13 @@ lazy val mimaSettings =
       ProblemFilters.exclude[DirectMissingMethodProblem]("org.specs2.specification.core.Env.shutdown"),
       ProblemFilters.exclude[DirectMissingMethodProblem]("org.specs2.specification.core.Env.shutdownResult"),
       ProblemFilters.exclude[DirectMissingMethodProblem]("org.specs2.specification.core.Env.awaitShutdown"),
-      ProblemFilters.exclude[DirectMissingMethodProblem]("org.specs2.specification.core.EnvDefault.<clinit>")
+      ProblemFilters.exclude[DirectMissingMethodProblem]("org.specs2.specification.core.EnvDefault.<clinit>"),
+
+      // The OwnEnv and OwnExecutionEnv traits should not expect to have a val env defined when mixed with a specification
+      // Because, in that case, it is very possible to confuse the ownEnv with the env and shutdown the env
+      // which breaks the execution of the whole specification
+      ProblemFilters.exclude[DirectMissingMethodProblem]("org.specs2.specification.core.OwnEnv.ownEnv"),
+      ProblemFilters.exclude[DirectMissingMethodProblem]("org.specs2.specification.core.OwnExecutionEnv.env")
     )
   )