aboutsummaryrefslogtreecommitdiff
path: root/deploy
diff options
context:
space:
mode:
authorFabian Meumertzheim <fabian@meumertzhe.im>2022-12-13 15:38:37 +0100
committerFabian Meumertzheim <fabian@meumertzhe.im>2022-12-13 17:14:50 +0100
commit3053776429b1d5eb56ff85df8f0ccb61701d6f9f (patch)
treeebdc5b52183bff36eaf30bdbba0d0522fd1fae89 /deploy
parentc9aa340333982329928d428ed4cc717a77e20187 (diff)
downloadjazzer-api-3053776429b1d5eb56ff85df8f0ccb61701d6f9f.tar.gz
deploy: Host linked javadocs for all Maven artifacts
Getting clickable cross-references in Javadocs requires publishing the docs in order, which is documented in the new `CONTRIBUTING.md` guide.
Diffstat (limited to 'deploy')
-rw-r--r--deploy/BUILD.bazel30
1 files changed, 30 insertions, 0 deletions
diff --git a/deploy/BUILD.bazel b/deploy/BUILD.bazel
index 5570d5b6..fa10f6df 100644
--- a/deploy/BUILD.bazel
+++ b/deploy/BUILD.bazel
@@ -1,7 +1,21 @@
+load("@bazel_skylib//rules:common_settings.bzl", "bool_flag")
load("@rules_jvm_external//:defs.bzl", "java_export")
load("//:maven.bzl", "JAZZER_API_COORDINATES", "JAZZER_COORDINATES", "JAZZER_JUNIT_COORDINATES")
load("//bazel:compat.bzl", "SKIP_ON_WINDOWS")
+bool_flag(
+ name = "linked_javadoc",
+ build_setting_default = False,
+)
+
+config_setting(
+ name = "emit_linked_javadoc",
+ flag_values = {
+ ":linked_javadoc": "True",
+ },
+ visibility = ["//:__subpackages__"],
+)
+
sh_binary(
name = "deploy",
srcs = ["deploy.sh"],
@@ -10,6 +24,10 @@ sh_binary(
java_export(
name = "jazzer-api",
+ javadocopts = [
+ "-link",
+ "https://docs.oracle.com/en/java/javase/17/docs/api/",
+ ],
maven_coordinates = JAZZER_API_COORDINATES,
pom_template = "//deploy:jazzer-api.pom",
visibility = ["//visibility:public"],
@@ -44,6 +62,18 @@ java_export(
# Exclude the unshaded classes comprising com.code-intelligence:jazzer since the java_library
# target comprising jazzer-junit depend on the individual libraries, not the shaded jar.
deploy_env = ["//driver/src/main/java/com/code_intelligence/jazzer:jazzer_lib"],
+ javadocopts = [
+ "-link",
+ "https://docs.oracle.com/en/java/javase/17/docs/api/",
+ ] + select({
+ ":emit_linked_javadoc": [
+ "-link",
+ "https://codeintelligencetesting.github.io/jazzer-docs/jazzer-api/",
+ "-link",
+ "https://codeintelligencetesting.github.io/jazzer-docs/jazzer/",
+ ],
+ "//conditions:default": [],
+ }),
maven_coordinates = JAZZER_JUNIT_COORDINATES,
pom_template = "jazzer-junit.pom",
visibility = ["//visibility:public"],