Skip to content

Commit

Permalink
release 2.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
siordache committed Jan 8, 2022
1 parent 7a335ea commit 3de652b
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 3 deletions.
24 changes: 23 additions & 1 deletion README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ To use the plugin, include the following in your build script:
----
plugins {
id 'java'
id 'org.beryx.jar' version '2.0.0-rc-4'
id 'org.beryx.jar' version '2.0.0'
}
----

Expand Down Expand Up @@ -121,6 +121,21 @@ moduleConfig {
}
----

==== _neverCompileModuleInfo_: always use JavaParser and ASM to assemble the module descriptor
[purple]##default value: ## `false`

By default, if the version of your java toolchain is greater than 8, the plugin uses the java compiler to assemble a module descriptor from the `module-info.java` file.
In some cases this may fail because the plugin is not able to determine all the compiler and jvm settings required for a JPMS build.
A typical example is a project that uses Kotlin. In this case, you can set `neverCompileModuleInfo` to `true` in order to instruct the plugin to create the module descriptor using the JavaParser and the ASM library instead of the compiler.

[source,groovy]
----
moduleConfig {
neverCompileModuleInfo = true
...
}
----

=== Examples

The following projects illustrate how to use this plugin to create modular jars targeted to pre-Java 9 releases:
Expand All @@ -131,6 +146,13 @@ The following projects illustrate how to use this plugin to create modular jars
=== Projects using badass-jar-plugin
See https://github.com/beryx/badass-jar-plugin/wiki/Projects-using-badass-jar-plugin[this Wiki page].


=== Alternatives

Instead of this plugin you can use the https://github.com/java9-modularity/gradle-modules-plugin[gradle-modules-plugin] with the
https://github.com/java9-modularity/gradle-modules-plugin#separate-compilation-of-module-infojava[modularity.mixedJavaRelease] option.
Choose the solution that best suits your needs.

=== Acknowledgements

This plugin was heavily inspired by and includes code from
Expand Down
4 changes: 2 additions & 2 deletions gradle.properties
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
badassJarVersionMajor = 2
badassJarVersionMinor = 0
badassJarVersionPatch = 0
badassJarVersionLabel = rc-6
badassJarReleaseBuild = false
# badassJarVersionLabel = rc-6
badassJarReleaseBuild = true

0 comments on commit 3de652b

Please sign in to comment.