This is an automated email from the ASF dual-hosted git repository. mdedetrich pushed a commit to branch document-how-to-use-plugin-under-jdk8 in repository https://gitbox.apache.org/repos/asf/incubator-pekko-sbt-paradox.git
commit c3ec43bb5b01616b253766e98cf7dd5d5b6b2df5 Author: Matthew de Detrich <[email protected]> AuthorDate: Thu Feb 9 11:27:14 2023 +0100 Document how to use plugin under JDK 1.8 --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index de8969e..2a064a8 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,25 @@ Use the sbt plugin for Pekko Paradox: addSbtPlugin("org.apache.pekko" % "pekko-sbt-paradox" % "<version>") ``` +### Usage within JDK 1.8 projects + +Due to the design of certain transitive dependencies used by sbt-paradox such as parboiled, this plugin won't +work correctly if run under JDK 1.8 + +You can work around this by hotpatching the resolved dependencies, rather than doing the simple `addSbtPlugin` +as mentioned before do the following + +```sbt +addSbtPlugin("org.apache.pekko" % "sbt-paradox-pekko" % "<version>" excludeAll( + "com.lightbend.paradox" % "sbt-paradox", + "com.lightbend.paradox" % "sbt-paradox-apidoc", + "com.lightbend.paradox" % "sbt-paradox-project-info" +)) +addSbtPlugin("com.lightbend.paradox" % "sbt-paradox" % "0.9.2" force()) +addSbtPlugin("com.lightbend.paradox" % "sbt-paradox-apidoc" % "0.10.1" force()) +addSbtPlugin("com.lightbend.paradox" % "sbt-paradox-project-info" % "2.0.0" force()) +``` + Enable it instead of the upstream ParadoxPlugin: ```sbt import org.apache.pekko.PekkoParadoxPlugin --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
