You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@spark.apache.org by do...@apache.org on 2024/08/19 03:03:53 UTC

(spark-kubernetes-operator) branch main updated: [SPARK-49291] Fix `javadoc` generation and add `lint` test pipeline to prevent

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

dongjoon pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/spark-kubernetes-operator.git


The following commit(s) were added to refs/heads/main by this push:
     new 5dd8961  [SPARK-49291] Fix `javadoc` generation and add `lint` test pipeline to prevent
5dd8961 is described below

commit 5dd89614650e031509b56cd1bc7e121287036b96
Author: Dongjoon Hyun <do...@apache.org>
AuthorDate: Sun Aug 18 20:03:45 2024 -0700

    [SPARK-49291] Fix `javadoc` generation and add `lint` test pipeline to prevent
    
    ### What changes were proposed in this pull request?
    
    This PR aims to fix `javadoc` generation and add `lint` GitHub Action job to prevent.
    
    In addition, `HelmChart` lint step is also moved into new `lint` GitHub Action job.
    
    ### Why are the changes needed?
    
    Currently, `javadoc` task fails due to `bad HTML entity` errors.
    ```
    $ ./gradlew javadoc
    ...
    > Task :spark-operator:javadoc FAILED
    /Users/dongjoon/APACHE/spark-kubernetes-operator/spark-operator/src/main/java/org/apache/spark/k8s/operator/config/SparkOperatorConfigMapReconciler.java:43: error: bad HTML entity
     * is located in given config map. It would keep watch the config map & apply changes when update is
    ...
    4 errors
    ...
    BUILD FAILED in 1s
    8 actionable tasks: 1 executed, 7 up-to-date
    ```
    
    ### Does this PR introduce _any_ user-facing change?
    
    No.
    
    ### How was this patch tested?
    
    Pass the CIs with newly added `lint` CI test job.
    
    ### Was this patch authored or co-authored using generative AI tooling?
    
    No.
    
    Closes #62 from dongjoon-hyun/SPARK-49291.
    
    Authored-by: Dongjoon Hyun <do...@apache.org>
    Signed-off-by: Dongjoon Hyun <do...@apache.org>
---
 .github/workflows/build_and_test.yml               | 24 +++++++++++++++++++---
 .../apache/spark/k8s/operator/SparkOperator.java   |  2 +-
 .../config/SparkOperatorConfigMapReconciler.java   |  4 ++--
 .../k8s/operator/utils/SparkAppStatusUtils.java    |  2 +-
 .../spark/k8s/operator/utils/StatusRecorder.java   |  4 ++--
 5 files changed, 27 insertions(+), 9 deletions(-)

diff --git a/.github/workflows/build_and_test.yml b/.github/workflows/build_and_test.yml
index 3c9df9a..7104993 100644
--- a/.github/workflows/build_and_test.yml
+++ b/.github/workflows/build_and_test.yml
@@ -44,9 +44,6 @@ jobs:
       - name: Build with Gradle
         run: |
           ./gradlew build
-      - name: Validate helm chart linting
-        run: |
-          helm lint --strict build-tools/helm/spark-kubernetes-operator
   build-image:
     name: "Build Operator Image CI"
     runs-on: ubuntu-latest
@@ -95,3 +92,24 @@ jobs:
           ./gradlew spark-operator-api:relocateGeneratedCRD
           helm install spark-kubernetes-operator --create-namespace -f build-tools/helm/spark-kubernetes-operator/values.yaml build-tools/helm/spark-kubernetes-operator/
           helm test spark-kubernetes-operator
+  lint:
+    name: "Linter and documentation"
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+      - name: Set up JDK 17
+        uses: actions/setup-java@v4
+        with:
+          java-version: 17
+          distribution: 'adopt'
+          cache: 'gradle'
+      - name: Linters
+        run: |
+          ./gradlew build -x test
+      - name: Javadoc Generation
+        run: |
+          ./gradlew javadoc
+      - name: Validate helm chart linting
+        run: |
+          helm lint --strict build-tools/helm/spark-kubernetes-operator
diff --git a/spark-operator/src/main/java/org/apache/spark/k8s/operator/SparkOperator.java b/spark-operator/src/main/java/org/apache/spark/k8s/operator/SparkOperator.java
index d9d50a1..6de2311 100644
--- a/spark-operator/src/main/java/org/apache/spark/k8s/operator/SparkOperator.java
+++ b/spark-operator/src/main/java/org/apache/spark/k8s/operator/SparkOperator.java
@@ -52,7 +52,7 @@ import org.apache.spark.k8s.operator.reconciler.SparkAppReconciler;
 import org.apache.spark.k8s.operator.utils.SparkAppStatusRecorder;
 
 /**
- * Entry point for Spark Operator. Bootstrap the operator app by starting watch & reconciler for
+ * Entry point for Spark Operator. Bootstrap the operator app by starting watch and reconciler for
  * SparkApps, starting watch for hot property loading, if enabled, and starting metrics server with
  * sentinel monitor if enabled
  */
diff --git a/spark-operator/src/main/java/org/apache/spark/k8s/operator/config/SparkOperatorConfigMapReconciler.java b/spark-operator/src/main/java/org/apache/spark/k8s/operator/config/SparkOperatorConfigMapReconciler.java
index 8a5c514..182f423 100644
--- a/spark-operator/src/main/java/org/apache/spark/k8s/operator/config/SparkOperatorConfigMapReconciler.java
+++ b/spark-operator/src/main/java/org/apache/spark/k8s/operator/config/SparkOperatorConfigMapReconciler.java
@@ -40,8 +40,8 @@ import lombok.extern.slf4j.Slf4j;
 
 /**
  * This serves dynamic configuration for Spark Operator. When enabled, Operator assumes config file
- * is located in given config map. It would keep watch the config map & apply changes when update is
- * detected.
+ * is located in given config map. It would keep watch the config map and apply changes when update
+ * is detected.
  */
 @ControllerConfiguration
 @RequiredArgsConstructor
diff --git a/spark-operator/src/main/java/org/apache/spark/k8s/operator/utils/SparkAppStatusUtils.java b/spark-operator/src/main/java/org/apache/spark/k8s/operator/utils/SparkAppStatusUtils.java
index bf47a79..199c7b0 100644
--- a/spark-operator/src/main/java/org/apache/spark/k8s/operator/utils/SparkAppStatusUtils.java
+++ b/spark-operator/src/main/java/org/apache/spark/k8s/operator/utils/SparkAppStatusUtils.java
@@ -24,7 +24,7 @@ import org.apache.spark.k8s.operator.SparkApplication;
 import org.apache.spark.k8s.operator.status.ApplicationState;
 import org.apache.spark.k8s.operator.status.ApplicationStateSummary;
 
-/** Handy utils for create & manage Application Status */
+/** Handy utils for create and manage Application Status */
 public final class SparkAppStatusUtils {
 
   private SparkAppStatusUtils() {}
diff --git a/spark-operator/src/main/java/org/apache/spark/k8s/operator/utils/StatusRecorder.java b/spark-operator/src/main/java/org/apache/spark/k8s/operator/utils/StatusRecorder.java
index 7aa7c42..f03187c 100644
--- a/spark-operator/src/main/java/org/apache/spark/k8s/operator/utils/StatusRecorder.java
+++ b/spark-operator/src/main/java/org/apache/spark/k8s/operator/utils/StatusRecorder.java
@@ -47,8 +47,8 @@ import org.apache.spark.k8s.operator.status.BaseStatus;
  * <a href="https://github.com/apache/flink-kubernetes-operator/blob/main/flink-kubernetes-operator/src/main/java/org/apache/flink/kubernetes/operator/utils/AppStatusRecorder.java">Flink Operator Status Recorder</a>
  * </pre>
  *
- * Enables additional (extendable) observers for Spark App status. Cache & version locking might be
- * removed in future version as batch app does not expect spec change after submitted.
+ * Enables additional (extendable) observers for Spark App status. Cache and version locking might
+ * be removed in future version as batch app does not expect spec change after submitted.
  */
 @Slf4j
 public class StatusRecorder<


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@spark.apache.org
For additional commands, e-mail: commits-help@spark.apache.org