2019-08-02 01:05:09 +00:00
< p align = "right" >
< a href = "https://autorelease.general.dmz.palantir.tech/palantir/gradle-graal" > < img src = "https://img.shields.io/badge/Perform%20an-Autorelease-success.svg" alt = "Autorelease" > < / a >
< / p >
2018-08-30 00:51:11 +00:00
gradle-graal
------------
A simple wrapper around GraalVM tooling that will download and locally cache a GraalVM installation and make
available select parts of the GraalVM compiler for use in Gradle builds.
To use this plugin, apply `com.palantir.graal` . See a full example in the
2018-10-02 21:44:14 +00:00
[ETE tests ](src/test/groovy/com/palantir/gradle/graal/GradleGraalEndToEndSpec.groovy ).
2018-08-30 00:51:11 +00:00
Gradle Tasks
------------
`./gradlew nativeImage` : create a native image using GraalVM's `native-image` tool with the configuration as specified
by the `graal` Gradle extension. Outputs are produced to `${projectDir}/build/graal/` .
2019-03-02 08:47:27 +00:00
`./gradlew sharedLibary` : create a shared library using GraalVM's `native-image` tool with the configuration as specified
by the `graal` Gradle extension. Outputs are produced to `${projectDir}/build/graal/` .
2018-08-30 00:51:11 +00:00
Configuration
-------------
Configure this plugin and its wrappers around GraalVM tools through the `graal` extension with the following options:
**General GraalVM controls**
2020-10-29 15:36:34 +00:00
* `graalVersion` : the version string to use when downloading GraalVM (defaults to `20.2.0` )
2018-08-30 00:51:11 +00:00
* `downloadBaseUrl` : the base download URL to use (defaults to `https://github.com/oracle/graal/releases/download/` )
2020-05-18 16:16:39 +00:00
* `javaVersion` : the Java version to use (can be either `8` or `11` , defaults to `8` )
* for `8` : Windows SDK 7.1 will be used (`C:\Program Files\Microsoft SDKs\Windows\v7.1\Bin\SetEnv.cmd`)
* for `11` : Visual Studio Build Tools will be used (`C:\Program Files (x86)\Microsoft Visual Studio\{version}\\{edition}\\VC\\Auxiliary\\Build\\vcvars64.bat`)
* `windowsVsVersion` : the version of Visual Studio to use (can be either `2017` or `2019` , by default a search will be performed and the newest will be selected)
* `windowsVsEdition` : the edition of Visual Studio to use (can be either `Community` , `Professional` or `Enterprise` , by default a search will be performed and the biggest will be selected)
* `windowsVsVarsPath` : path to vcvars64.bat (optional, if it's set it will disable the 2 searches for `vsVersion` and `vsEdition` )
2018-08-30 00:51:11 +00:00
2019-03-02 08:47:27 +00:00
2018-08-30 00:51:11 +00:00
**`native-image` controls**
* `outputName` : the name to use for the image output
* `mainClass` : the main class entry-point for the image to run
2020-10-29 13:30:43 +00:00
* `option` : additional native-image options `https://github.com/oracle/graal/blob/master/substratevm/Options.md`
2018-08-30 00:51:11 +00:00
Local GraalVM Tooling Cache
---------------------------
We maintain a number of different repositories, and rather than re-download tooling and cache it per repository, this
plugin maintains a central cache in the user's home directory (`~/.gradle/caches/com.palantir.graal`). Tooling artifacts
are cached by version, so multiple projects referring to different GraalVM versions will not corrupt the cache.
No locking is performed to check the atomicity of changes to the cache, so users should not expect this plugin to be
well behaved when populating the cache from parallel processes.
Contributions
-------------
Contributions are welcome. For larger feature requests or contributions, we prefer discussing the proposed change on
a GitHub issue prior to a PR.
License
-------
This plugin is made available under the [Apache 2.0 License ](http://www.apache.org/licenses/LICENSE-2.0 ).
