Document how to use snapshot releases

graalvm · Aug 23, 2021 · ca0d259 · ca0d259
1 parent 70d4161
commit ca0d259
Show file tree

Hide file tree

Showing 2 changed files with 57 additions and 0 deletions.
diff --git a/docs/src/docs/asciidoc/gradle-plugin.adoc b/docs/src/docs/asciidoc/gradle-plugin.adoc
@@ -60,6 +60,41 @@ pluginManagement {
 }
 ```
 
+[TIP]
+.Testing pre-releases
+====
+You can use the development versions of the plugin by adding our snapshot repository instead. Pre-releases are provided for convenience, without any guarantee.
+[role="multi-language-sample"]
+```groovy
+pluginManagement {
+    plugins {
+        id 'org.graalvm.buildtools.native' version '...'
+    }
+    repositories {
+        maven {
+            url "https://raw.githubusercontent.com/graalvm/native-build-tools/snapshots"
+        }
+        gradlePluginPortal()
+    }
+}
+```
+
+[role="multi-language-sample"]
+```kotlin
+pluginManagement {
+    plugins {
+        id("org.graalvm.buildtools.native") version "..."
+    }
+    repositories {
+        maven {
+            url = uri("https://raw.githubusercontent.com/graalvm/native-build-tools/snapshots")
+        }
+        gradlePluginPortal()
+    }
+}
+```
+====
+
 === Installing GraalVM native image tool
 
 The plugin relies on Gradle's https://docs.gradle.org/7.1.1/userguide/toolchains.html[JVM toolchain support], allowing to decorrelate the tool used to run Gradle, the compiler used to build your application, and eventually the SDK used to generate a native image.

diff --git a/docs/src/docs/asciidoc/maven-plugin.adoc b/docs/src/docs/asciidoc/maven-plugin.adoc
@@ -63,6 +63,28 @@ If the heuristics fails with the `no main manifest attribute, in target/<name>.j
 specified in the `<configuration>` node of the plugin.
 When `mvn -Pnative package` completes, an executable is ready for use, generated in the `target` directory of the project.
 
+[TIP]
+.Testing pre-releases
+====
+You can use the development versions of the plugin by adding our snapshot repository. Pre-releases are provided for convenience, without any guarantee.
+[source,xml]
+----
+<pluginRepositories>
+    <pluginRepository>
+        <id>graalvm-native-build-tools-snapshots</id>
+        <name>GraalVM native-build-tools Snapshots</name>
+        <url>https://raw.githubusercontent.com/graalvm/native-build-tools/snapshots</url>
+        <releases>
+            <enabled>false</enabled>
+        </releases>
+        <snapshots>
+            <enabled>true</enabled>
+        </snapshots>
+    </pluginRepository>
+</pluginRepositories>
+----
+====
+
 === Configuration options
 
 If you use Native Image Maven plugin, it will pick up all the configuration for your application stored below the  _META-INF/native-image/_ resource location, as described in https://www.graalvm.org/reference-manual/native-image/BuildConfiguration/[Native Image Build Configuration].