[hudi] branch asf-site updated: [HUDI-6075] Improve config generation script and docs (#8465)

[yi...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

yihua pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/hudi.git


The following commit(s) were added to refs/heads/asf-site by this push:
     new 6bb4211c27b [HUDI-6075] Improve config generation script and docs (#8465)
6bb4211c27b is described below

commit 6bb4211c27ba7965943be4896419919b4a663bb5
Author: Y Ethan Guo <et...@gmail.com>
AuthorDate: Fri Apr 14 15:38:11 2023 -0700

    [HUDI-6075] Improve config generation script and docs (#8465)
    
    This commit improves config generation script by adding more bundles and revises the docs for clarity.
---
 hudi-utils/README.md          | 31 ++++++-------------------------
 hudi-utils/generate_config.sh | 19 +++++++++++--------
 2 files changed, 17 insertions(+), 33 deletions(-)

diff --git a/hudi-utils/README.md b/hudi-utils/README.md
index ce39aea016f..e3228a37fba 100644
--- a/hudi-utils/README.md
+++ b/hudi-utils/README.md
@@ -24,29 +24,10 @@ mvn clean
 mvn install
 ```
 
-When new config classes are added, or existing ones are moved to a separate module, 
-please add the corresponding bundle for configurations of that module to be picked up.
-Set the appropriate SNAPSHOT version and execute the below commands. Below commands are in the [generate_configs.sh](generate_config.sh) script.
-```shell
-VERSION=0.13.0
-
-JARS=(
-"$HOME/.m2/repository/org/apache/hudi/hudi-utilities-bundle_2.11/$VERSION-SNAPSHOT/hudi-utilities-bundle_2.11-$VERSION-SNAPSHOT.jar"
-"$HOME/.m2/repository/org/apache/hudi/hudi-spark2.4-bundle_2.11/$VERSION-SNAPSHOT/hudi-spark2.4-bundle_2.11-$VERSION-SNAPSHOT.jar"
-"$HOME/.m2/repository/org/apache/hudi/hudi-flink1.14-bundle_2.11/$VERSION-SNAPSHOT/hudi-flink1.14-bundle_2.11-$VERSION-SNAPSHOT.jar"
-"$HOME/.m2/repository/org/apache/hudi/hudi-kafka-connect-bundle/$VERSION-SNAPSHOT/hudi-kafka-connect-bundle-$VERSION-SNAPSHOT.jar"
-"$HOME/.m2/repository/org/apache/hudi/hudi-datahub-sync-bundle/$VERSION-SNAPSHOT/hudi-datahub-sync-bundle-$VERSION-SNAPSHOT.jar"
-"$HOME/.m2/repository/org/apache/hudi/hudi-gcp-bundle/$VERSION-SNAPSHOT/hudi-gcp-bundle-$VERSION-SNAPSHOT.jar"
-"$HOME/.m2/repository/org/apache/hudi/hudi-aws-bundle/$VERSION-SNAPSHOT/hudi-aws-bundle-$VERSION-SNAPSHOT.jar"
-)
-
-printf -v CLASSPATH ':%s' "${JARS[@]}"
-echo "CLASSPATH=$CLASSPATH"
-
-java -cp target/hudi-utils-1.0-SNAPSHOT-jar-with-dependencies.jar$CLASSPATH \
-org.apache.hudi.utils.HoodieConfigDocGenerator
-
-cp /tmp/configurations.md ../website/docs/configurations.md
-```
+When new config classes are added, or existing ones are moved to a separate module, please add the corresponding bundle 
+for configurations of that module to the script [`generate_configs.sh`](generate_config.sh) to be picked up.
+Set the appropriate version (either a snapshot version like `0.14.0-SNAPSHOT` or a public release version
+like `0.13.0`) in the script [`generate_configs.sh`](generate_config.sh) and run it to automatically generate the
+configuration documentation.
 
-Once complete, please put up a patch with latest configurations.
\ No newline at end of file
+Once complete, please put up a patch with the latest configurations.
\ No newline at end of file
diff --git a/hudi-utils/generate_config.sh b/hudi-utils/generate_config.sh
index 64e2b3dceef..ae8a3f0911a 100755
--- a/hudi-utils/generate_config.sh
+++ b/hudi-utils/generate_config.sh
@@ -17,16 +17,19 @@
 # limitations under the License.
 #
 
-VERSION=0.14.0
+VERSION=0.14.0-SNAPSHOT
 
 JARS=(
-"$HOME/.m2/repository/org/apache/hudi/hudi-utilities-bundle_2.11/$VERSION-SNAPSHOT/hudi-utilities-bundle_2.11-$VERSION-SNAPSHOT.jar"
-"$HOME/.m2/repository/org/apache/hudi/hudi-spark2.4-bundle_2.11/$VERSION-SNAPSHOT/hudi-spark2.4-bundle_2.11-$VERSION-SNAPSHOT.jar"
-"$HOME/.m2/repository/org/apache/hudi/hudi-flink1.14-bundle_2.11/$VERSION-SNAPSHOT/hudi-flink1.14-bundle_2.11-$VERSION-SNAPSHOT.jar"
-"$HOME/.m2/repository/org/apache/hudi/hudi-kafka-connect-bundle/$VERSION-SNAPSHOT/hudi-kafka-connect-bundle-$VERSION-SNAPSHOT.jar"
-"$HOME/.m2/repository/org/apache/hudi/hudi-datahub-sync-bundle/$VERSION-SNAPSHOT/hudi-datahub-sync-bundle-$VERSION-SNAPSHOT.jar"
-"$HOME/.m2/repository/org/apache/hudi/hudi-gcp-bundle/$VERSION-SNAPSHOT/hudi-gcp-bundle-$VERSION-SNAPSHOT.jar"
-"$HOME/.m2/repository/org/apache/hudi/hudi-aws-bundle/$VERSION-SNAPSHOT/hudi-aws-bundle-$VERSION-SNAPSHOT.jar"
+"$HOME/.m2/repository/org/apache/hudi/hudi-utilities-bundle_2.11/$VERSION/hudi-utilities-bundle_2.11-$VERSION.jar"
+"$HOME/.m2/repository/org/apache/hudi/hudi-spark2.4-bundle_2.11/$VERSION/hudi-spark2.4-bundle_2.11-$VERSION.jar"
+"$HOME/.m2/repository/org/apache/hudi/hudi-flink1.14-bundle_2.11/$VERSION/hudi-flink1.14-bundle_2.11-$VERSION.jar"
+"$HOME/.m2/repository/org/apache/hudi/hudi-kafka-connect-bundle/$VERSION/hudi-kafka-connect-bundle-$VERSION.jar"
+"$HOME/.m2/repository/org/apache/hudi/hudi-datahub-sync-bundle/$VERSION/hudi-datahub-sync-bundle-$VERSION.jar"
+"$HOME/.m2/repository/org/apache/hudi/hudi-gcp-bundle/$VERSION/hudi-gcp-bundle-$VERSION.jar"
+"$HOME/.m2/repository/org/apache/hudi/hudi-aws-bundle/$VERSION/hudi-aws-bundle-$VERSION.jar"
+"$HOME/.m2/repository/org/apache/hudi/hudi-hadoop-mr-bundle/$VERSION/hudi-hadoop-mr-bundle-$VERSION.jar"
+"$HOME/.m2/repository/org/apache/hudi/hudi-hive-sync-bundle/$VERSION/hudi-hive-sync-bundle-$VERSION.jar"
+"$HOME/.m2/repository/org/apache/hudi/hudi-metaserver-server-bundle/$VERSION/hudi-metaserver-server-bundle-$VERSION.jar"
 )
 
 printf -v CLASSPATH ':%s' "${JARS[@]}"