From abbb6521bf792043bcaa829d5484eee9ecb2ec18 Mon Sep 17 00:00:00 2001
From: Cheng Pan <chengpan@apache.org>
Date: Fri, 9 Aug 2024 13:11:50 +0800
Subject: [PATCH] [KYUUBI #6599] Disable Javadoc/Scaladoc by default
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

# :mag: Description

This PR disables Javadoc/Scaladoc by default, while still enabling that on Nexus deploy and CI, to speed up the normal building by developers daily performed.

## Types of changes :bookmark:

- [ ] Bugfix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to change)

## Test Plan 🧪

Apple M1 Max, Java 17

```
$ time build/mvn clean install -DskipTests
```

before: 1145.67s user 62.41s system 276% cpu 7:16.56 total
after: 530.33s user 35.82s system 214% cpu 4:23.69 total

---

# Checklist 📝

- [x] This patch was not authored or co-authored using [Generative Tooling](https://www.apache.org/legal/generative-tooling.html)

**Be nice. Be informative.**

Closes #6599 from pan3793/javadoc.

Closes #6599

660f8dc02 [Cheng Pan] Disable Javadoc/Scaladoc by default

Authored-by: Cheng Pan <chengpan@apache.org>
Signed-off-by: liangbowen <liangbowen@gf.com.cn>
(cherry picked from commit 71f95696e52c8b32a9d10009b4d4bf8d98048bbb)
Signed-off-by: liangbowen <liangbowen@gf.com.cn>
---
 .github/workflows/master.yml | 2 +-
 build/dist                   | 2 +-
 pom.xml                      | 9 ++++++---
 3 files changed, 8 insertions(+), 5 deletions(-)

diff --git a/.github/workflows/master.yml b/.github/workflows/master.yml
index 86a8388ab..14936dc55 100644
--- a/.github/workflows/master.yml
+++ b/.github/workflows/master.yml
@@ -106,7 +106,7 @@ jobs:
       - name: Build and test Kyuubi and Spark with maven w/o linters
         run: |
           if [[ "${{ matrix.java }}" == "8" && "${{ matrix.spark }}" == "3.5" && "${{ matrix.spark-archive }}" == "" ]]; then
-            MVN_OPT="${MVN_OPT} -Pcodecov"
+            MVN_OPT="${MVN_OPT} -Pcodecov -Dmaven.javadoc.skip=false -Dmaven.scaladoc.skip=false"
           fi
           TEST_MODULES="dev/kyuubi-codecov"
           ./build/mvn clean install ${MVN_OPT} -pl ${TEST_MODULES} -am \
diff --git a/build/dist b/build/dist
index b2b4b4abe..252d53c85 100755
--- a/build/dist
+++ b/build/dist
@@ -215,7 +215,7 @@ else
   echo "Making distribution for Kyuubi $VERSION in '$DISTDIR'..."
 fi
 
-MVN_DIST_OPT="-DskipTests -Dmaven.javadoc.skip=true -Dmaven.scaladoc.skip=true -Dmaven.source.skip"
+MVN_DIST_OPT="-DskipTests -Dmaven.source.skip"
 
 if [[ "$ENABLE_WEBUI" == "true" ]]; then
   MVN_DIST_OPT="$MVN_DIST_OPT -Pweb-ui"
diff --git a/pom.xml b/pom.xml
index 46457493e..237ad7b33 100644
--- a/pom.xml
+++ b/pom.xml
@@ -244,7 +244,8 @@
              we should skip upgrading until MSOURCES-141 gets fixed. -->
         <maven.plugin.source.version>3.2.1</maven.plugin.source.version>
 
-        <maven.scaladoc.skip>false</maven.scaladoc.skip>
+        <maven.javadoc.skip>true</maven.javadoc.skip>
+        <maven.scaladoc.skip>true</maven.scaladoc.skip>
         <maven.scalastyle.skip>false</maven.scalastyle.skip>
         <!-- Needed for consistent times -->
         <maven.build.timestamp.format>yyyy-MM-dd HH:mm:ss z</maven.build.timestamp.format>
@@ -2120,8 +2121,6 @@
             <id>fast</id>
             <properties>
                 <enforcer.skip>true</enforcer.skip>
-                <maven.javadoc.skip>true</maven.javadoc.skip>
-                <maven.scaladoc.skip>true</maven.scaladoc.skip>
                 <maven.scalastyle.skip>true</maven.scalastyle.skip>
                 <rat.skip>true</rat.skip>
                 <skipTests>true</skipTests>
@@ -2161,6 +2160,10 @@
 
         <profile>
             <id>apache-release</id>
+            <properties>
+                <maven.javadoc.skip>false</maven.javadoc.skip>
+                <maven.scaladoc.skip>false</maven.scaladoc.skip>
+            </properties>
             <build>
                 <plugins>
                     <!-- Prevent the source-release-assembly execution defined in the Apache parent POM