[#221] Document workaround for Grapes bug on Groovy versions before 2…

….4.7. Closes #221
remkop · Oct 29, 2017 · 5f8244a · 5f8244a
1 parent aff6e02
commit 5f8244a
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/RELEASE-NOTES.md b/RELEASE-NOTES.md
@@ -5,6 +5,7 @@
 ## <a name="2.1.0-fixes"></a> Fixed issues
 
 - [#220] Improve tracing for positional parameters (provide detail on current position).
+- [#221] Document workaround for Grapes bug on Groovy versions before 2.4.7.
 
 # <a name="2.0.1"></a> Picocli 2.0.1
 

diff --git a/docs/index.adoc b/docs/index.adoc
@@ -1899,6 +1899,16 @@ count.times {
 assert this.commandLine.commandName == "myCommand"
 ----
 
+CAUTION: When using a Groovy version older than 2.4.7, use this workaround for the https://issues.apache.org/jira/browse/GROOVY-7613[Grape bug] that causes this error:
+`java.lang.ClassNotFoundException: # Licensed to the Apache Software Foundation (ASF) under one or more`.
+
+[source,groovy]
+----
+@Grab('info.picocli:picocli:2.1.0-SNAPSHOT')
+@GrabExclude('org.codehaus.groovy:groovy-all') // work around GROOVY-7613
+...
+----
+
 === Kotlin
 Kotlin does not allow specifying an array https://kotlinlang.org/docs/reference/annotations.html[annotation]
  attribute as a single value,