chore(CI): get docs building on ALL branches. (#26854)

apache · Jan 29, 2024 · 8db5d13 · 8db5d13
1 parent c3aacc6
commit 8db5d13
Show file tree

Hide file tree

Showing 4 changed files with 36 additions and 12 deletions.
diff --git a/.github/workflows/superset-docs.yml → .github/workflows/superset-docs-deploy.yml b/.github/workflows/superset-docs.yml → .github/workflows/superset-docs-deploy.yml
@@ -1,15 +1,11 @@
-name: Docs
+name: Docs Deployment
 
 on:
   push:
     paths:
       - "docs/**"
     branches:
-      - 'master'
-  pull_request:
-    paths:
-      - "docs/**"
-    types: [synchronize, opened, reopened, ready_for_review]
+      - "master"
 
 jobs:
   config:
@@ -51,9 +47,9 @@ jobs:
         env:
           API_TOKEN_GITHUB: ${{ secrets.SUPERSET_SITE_BUILD }}
         with:
-          source-directory: './docs/build'
-          destination-github-username: 'apache'
-          destination-repository-name: 'superset-site'
-          target-branch: 'asf-site'
+          source-directory: "./docs/build"
+          destination-github-username: "apache"
+          destination-repository-name: "superset-site"
+          target-branch: "asf-site"
           commit-message: "deploying docs: ${{ github.event.head_commit.message }} (apache/superset@${{ github.sha }})"
           user-email: [email protected]
diff --git a/.github/workflows/superset-docs-verify.yml b/.github/workflows/superset-docs-verify.yml
@@ -0,0 +1,29 @@
+name: Docs Testing
+
+on:
+  pull_request:
+    paths:
+      - "docs/**"
+    types: [synchronize, opened, reopened, ready_for_review]
+jobs:
+  build-deploy:
+    name: Build & Deploy
+    runs-on: ubuntu-20.04
+    defaults:
+      run:
+        working-directory: docs
+    steps:
+      - name: "Checkout ${{ github.ref }} ( ${{ github.sha }} )"
+        uses: actions/checkout@v3
+        with:
+          persist-credentials: false
+          submodules: recursive
+      - name: yarn install
+        run: |
+          yarn install --check-cache
+      - name: yarn typecheck
+        run: |
+          yarn typecheck
+      - name: yarn build
+        run: |
+          yarn build
diff --git a/docs/src/components/SectionHeader.tsx b/docs/src/components/SectionHeader.tsx
@@ -96,7 +96,7 @@ const StyledSectionHeaderH2 = styled(StyledSectionHeader)`
 interface SectionHeaderProps {
   level: any;
   title: string;
-  subtitle?: string;
+  subtitle?: string | Element | React.ReactNode;
   dark?: boolean;
 }
 

diff --git a/docs/src/pages/community.tsx b/docs/src/pages/community.tsx
@@ -217,7 +217,6 @@ const Community = () => {
                     </a>
                   }
                   description={<p className="description">{description}</p>}
-                  role="group"
                   aria-label="Community link"
                 />
               </List.Item>