From 0efb705c41eec9bd33616a362e70a92aa2c88602 Mon Sep 17 00:00:00 2001 From: Adam Retter Date: Thu, 21 Dec 2023 20:23:29 +0100 Subject: [PATCH] Add CI Job to enforce correct JavaDocs --- .circleci/config.yml | 18 ++++++++++++++++++ java/Makefile | 2 +- 2 files changed, 19 insertions(+), 1 deletion(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index 370ad301a8dd..5a9c7c6382d4 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -677,6 +677,23 @@ jobs: command: scl enable devtoolset-7 'make V=1 J=8 -j8 rocksdbjavastatic' - post-steps + check-javadocs: + executor: linux-java-docker + resource_class: large + steps: + - pre-steps + - run: + name: "Set Java Environment" + command: | + echo "JAVA_HOME=${JAVA_HOME}" + echo 'export PATH=$JAVA_HOME/bin:$PATH' >> $BASH_ENV + which java && java -version + which javac && javac -version + - run: + name: "Check RocksDBJava JavaDocs" + command: scl enable devtoolset-7 'pushd java; make V=1 J=8 -j8 javadocs' + - post-steps + build-macos-java: macos: xcode: 14.3.1 @@ -924,6 +941,7 @@ workflows: - build-macos-java-static - build-macos-java-static-universal - build-linux-java-pmd + - check-javadocs jobs-macos: jobs: - build-macos diff --git a/java/Makefile b/java/Makefile index a887a24b3054..b022c12d88cf 100644 --- a/java/Makefile +++ b/java/Makefile @@ -341,7 +341,7 @@ clean-downloaded: javadocs: java $(AM_V_GEN)mkdir -p $(JAVADOC) - $(AM_V_at)$(JAVADOC_CMD) -d $(JAVADOC) -sourcepath $(MAIN_SRC) -subpackages org + $(AM_V_at)$(JAVADOC_CMD) -Werror -d $(JAVADOC) -sourcepath $(MAIN_SRC) -subpackages org javalib: java java_test javadocs