Add Ocaml example

aalmiray · aalmiray · commit 9b37f3161410 · 2025-01-07T20:25:48.000+01:00
diff --git a/docs/modules/ROOT/pages/index.adoc b/docs/modules/ROOT/pages/index.adoc
@@ -27,6 +27,7 @@ Examples of non-Java projects:
  * xref:examples:miscellaneous/go.adoc[]
  * xref:examples:miscellaneous/haskell.adoc[]
  * xref:examples:miscellaneous/nim.adoc[]
+ * xref:examples:miscellaneous/ocaml.adoc[]
  * xref:examples:miscellaneous/odin.adoc[]
  * xref:examples:miscellaneous/perl.adoc[]
  * xref:examples:miscellaneous/rust-cross-platform.adoc[]
diff --git a/docs/modules/examples/nav.adoc b/docs/modules/examples/nav.adoc
@@ -30,6 +30,7 @@
 *** xref:miscellaneous/go.adoc[]
 *** xref:miscellaneous/haskell.adoc[]
 *** xref:miscellaneous/nim.adoc[]
+*** xref:miscellaneous/ocaml.adoc[]
 *** xref:miscellaneous/odin.adoc[]
 *** xref:miscellaneous/perl.adoc[]
 *** xref:miscellaneous/rust-cross-platform.adoc[]
diff --git a/docs/modules/examples/pages/miscellaneous/cpp.adoc b/docs/modules/examples/pages/miscellaneous/cpp.adoc
@@ -1,4 +1,4 @@
-= Helloworld in CPP
+= Helloworld in C++
 
 The link:https://github.com/jreleaser/helloworld-cpp[] repository shows the configuration and steps to:
 
diff --git a/docs/modules/examples/pages/miscellaneous/csharp-cross-platform.adoc b/docs/modules/examples/pages/miscellaneous/csharp-cross-platform.adoc
@@ -1,4 +1,4 @@
-= Helloworld in C# (Cross Platform)
+= Helloworld in C#
 
 The link:https://github.com/jreleaser/helloworld-csharp[] repository shows the configuration and steps to:
 
diff --git a/docs/modules/examples/pages/miscellaneous/index.adoc b/docs/modules/examples/pages/miscellaneous/index.adoc
@@ -13,6 +13,7 @@
 * xref:miscellaneous/go.adoc[]
 * xref:miscellaneous/haskell.adoc[]
 * xref:miscellaneous/nim.adoc[]
+* xref:miscellaneous/ocaml.adoc[]
 * xref:miscellaneous/odin.adoc[]
 * xref:miscellaneous/perl.adoc[]
 * xref:miscellaneous/rust-cross-platform.adoc[]
diff --git a/docs/modules/examples/pages/miscellaneous/ocaml.adoc b/docs/modules/examples/pages/miscellaneous/ocaml.adoc
@@ -0,0 +1,13 @@
+= Helloworld in OCaml
+
+The link:https://github.com/jreleaser/helloworld-ocaml[] repository shows the configuration and steps to:
+
+ - Compile a helloworld app for the following targets:
+   ** `osx-aarch_64`
+   ** `osx-x86_64`
+   ** `linux-x86_64`
+ - Assemble zip distributions with JReleaser
+ - Create rolling early-access releases with JReleaser on every push to `main` branch
+
+IMPORTANT: JReleaser requires 2 additional inputs that may be set as environment variables, `JRELEASER_PROJECT_VERSION` and `JRELEASER_GITHUB_TOKEN`.
+More information about environment variable configuration may be found xref:reference:environment.adoc[here].
diff --git a/docs/modules/examples/pages/miscellaneous/rust-cross-platform.adoc b/docs/modules/examples/pages/miscellaneous/rust-cross-platform.adoc
@@ -1,4 +1,4 @@
-= Helloworld in Rust (Cross Platform)
+= Helloworld in Rust
 
 The link:https://github.com/jreleaser/helloworld-rustx[] repository shows the configuration and steps to:
 

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-= Helloworld in CPP`
	`1`	`+= Helloworld in C++`
`2`	`2`
`3`	`3`	`The link:https://github.com/jreleaser/helloworld-cpp[] repository shows the configuration and steps to:`
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-= Helloworld in C# (Cross Platform)`
	`1`	`+= Helloworld in C#`
`2`	`2`
`3`	`3`	`The link:https://github.com/jreleaser/helloworld-csharp[] repository shows the configuration and steps to:`
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-= Helloworld in Rust (Cross Platform)`
	`1`	`+= Helloworld in Rust`
`2`	`2`
`3`	`3`	`The link:https://github.com/jreleaser/helloworld-rustx[] repository shows the configuration and steps to:`
`4`	`4`