(incubator-pekko-sbt-paradox) branch main updated: Document excludesAll for additional sbt-paradox plugins

[md...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

mdedetrich pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-pekko-sbt-paradox.git


The following commit(s) were added to refs/heads/main by this push:
     new d47e88d  Document excludesAll for additional sbt-paradox plugins
d47e88d is described below

commit d47e88d12a922d678048306d9b069106162cb00f
Author: Matthew de Detrich <ma...@aiven.io>
AuthorDate: Sun Mar 3 13:57:24 2024 +0100

    Document excludesAll for additional sbt-paradox plugins
---
 README.md | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/README.md b/README.md
index 6a74195..a06c39b 100644
--- a/README.md
+++ b/README.md
@@ -36,6 +36,18 @@ so you can just include it like this
 addSbtPlugin("org.apache.pekko" % "sbt-paradox-pekko" % "<version>")
 ```
 
+> **_NOTE:_** If you happen to be using sbt-paradox plugins aside from
+> * sbt-web
+> * sbt-paradox-apidoc
+> * sbt-paradox-project-info
+> you need to use an `excludesAll` statement on `addSbtPlugin` to remove the
+> JDK 11 reference, i.e. if you need to use sbt-site-paradox you would do the
+> following
+> ```sbt
+> addSbtPlugin(("com.github.sbt" % "sbt-site-paradox" % "1.5.0").excludeAll(
+> "com.lightbend.paradox", "sbt-paradox"))
+> ```
+
 ### JDK 11+
 
 With JDK 11 or later you need to explicitly override the sbt-paradox/sbt-paradox-theme


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@pekko.apache.org
For additional commands, e-mail: commits-help@pekko.apache.org