From 64a29c61e47442dbca84ee4bfca9815fd546a26f Mon Sep 17 00:00:00 2001
From: Jay Chung <zhongjiajie955@gmail.com>
Date: Wed, 23 Nov 2022 18:26:05 +0800
Subject: [PATCH] [ci] Require docs context before merge, and run spotless
 check (#12977)

Find out there are some docs formatter that will fail our CI,
due to we merge some wrong PR accidents, such as
https://github.com/apache/dolphinscheduler/pull/12940

This patch asks spotless check run in docs only check to
avoid regression too
---
 .asf.yaml                  |  1 +
 .github/workflows/docs.yml | 23 +++++++++++++++++++++--
 2 files changed, 22 insertions(+), 2 deletions(-)

diff --git a/.asf.yaml b/.asf.yaml
index 8064016885..9043e652a7 100644
--- a/.asf.yaml
+++ b/.asf.yaml
@@ -41,6 +41,7 @@ github:
           - Build
           - Unit Test
           - E2E
+          - Docs
           - "Mergeable: milestone-label-check"
       required_pull_request_reviews:
         dismiss_stale_reviews: true
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
index 7f053d8949..1a602ee5b2 100644
--- a/.github/workflows/docs.yml
+++ b/.github/workflows/docs.yml
@@ -31,8 +31,14 @@ concurrency:
   cancel-in-progress: true
 
 jobs:
+  style:
+    timeout-minutes: 10
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Style Check
+        run: ./mvnw spotless:check
   img-check:
-    name: Image Check
     timeout-minutes: 15
     runs-on: ubuntu-latest
     defaults:
@@ -49,7 +55,6 @@ jobs:
       - name: Run Image Check
         run: python img_utils.py -v check
   dead-link:
-    name: Dead Link
     if: (github.event_name == 'schedule' && github.repository == 'apache/dolphinscheduler') || (github.event_name != 'schedule')
     runs-on: ubuntu-latest
     timeout-minutes: 30
@@ -62,3 +67,17 @@ jobs:
           for file in $(find . -name "*.md"); do
             markdown-link-check -c .dlc.json -q "$file"
           done
+  result:
+    name: Docs
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    needs:
+      - style
+      - img-check
+      - dead-link
+    if: success()
+    steps:
+      - name: success
+        run: |
+          echo "Docs check success"
+          exit 0