Skip to content

Commit b81536d

Browse files
committed
Add link to the samples and mention JUnit version
Fixes #297
1 parent abbedfb commit b81536d

File tree

2 files changed

+12
-0
lines changed

2 files changed

+12
-0
lines changed

docs/src/docs/asciidoc/gradle-plugin.adoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,11 @@ For upgrading please take a look at the <<index.adoc#changelog,Changelog>>.
1212

1313
== Quickstart
1414

15+
[NOTE]
16+
====
17+
You can find full samples in https://github.com/graalvm/native-build-tools/tree/master/samples[the source repository].
18+
====
19+
1520
=== Adding the plugin
1621

1722
Add following to `plugins` section of your project's `build.gradle` / `build.gradle.kts`:
@@ -215,6 +220,7 @@ When the `classpathJar` property is set, the `classpath` property is _ignored_.
215220
This plugin supports running tests on the
216221
https://junit.org/junit5/docs/current/user-guide/[JUnit Platform] as native images. This
217222
means that tests will be compiled and executed as native code.
223+
The minimal supported version is JUnit Platform 5.8.1.
218224

219225
In theory, any `TestEngine` supported on the JUnit Platform should be supported by this
220226
plugin as long as the programming language used by the `TestEngine` and the programming

docs/src/docs/asciidoc/maven-plugin.adoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,11 @@ For upgrading please take a look at the <<index.adoc#changelog,Changelog>>.
1414
[[quickstart]]
1515
== Quickstart
1616

17+
[NOTE]
18+
====
19+
You can find full samples in https://github.com/graalvm/native-build-tools/tree/master/samples[the source repository].
20+
====
21+
1722
This plugin first requires that you <<graalvm-setup.adoc#,setup GraalVM and `native-image` properly>>.
1823
It will then make use of Maven profiles to enable building and testing of native images.
1924

@@ -296,6 +301,7 @@ In this case, the arguments that will be passed to the `native-image` executable
296301
This plugin supports running tests on the
297302
https://junit.org/junit5/docs/current/user-guide/[JUnit Platform] as native images. This
298303
means that tests will be compiled and executed as native code.
304+
The minimal supported version is JUnit Platform 5.8.1.
299305

300306
In theory, any `TestEngine` supported on the JUnit Platform should be supported by this
301307
plugin as long as the programming language used by the `TestEngine` and the programming

0 commit comments

Comments
 (0)