Skip to content

Commit

Permalink
Add CI Job to enforce correct JavaDocs
Browse files Browse the repository at this point in the history
  • Loading branch information
adamretter committed Dec 21, 2023
1 parent 10bb07a commit 0efb705
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 1 deletion.
18 changes: 18 additions & 0 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion java/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit 0efb705

Please sign in to comment.