You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@superset.apache.org by ru...@apache.org on 2024/01/29 19:36:46 UTC
(superset) 01/01: chore(CI): get docs building on ALL branches.
This is an automated email from the ASF dual-hosted git repository.
rusackas pushed a commit to branch fix-docs-CI
in repository https://gitbox.apache.org/repos/asf/superset.git
commit 7c107a1014f1aeac52288f4d6aa10325328de04f
Author: Evan Rusackas <ev...@rusackas.com>
AuthorDate: Mon Jan 29 12:36:33 2024 -0700
chore(CI): get docs building on ALL branches.
---
.github/workflows/superset-docs-deploy.yml | 29 ++++++++++++++++++++++
...{superset-docs.yml => superset-docs-verify.yml} | 16 +++++-------
docs/src/components/SectionHeader.tsx | 2 +-
docs/src/pages/community.tsx | 1 -
4 files changed, 36 insertions(+), 12 deletions(-)
diff --git a/.github/workflows/superset-docs-deploy.yml b/.github/workflows/superset-docs-deploy.yml
new file mode 100644
index 0000000000..6c0b158ea6
--- /dev/null
+++ b/.github/workflows/superset-docs-deploy.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 buitypecheck
+ - name: yarn build
+ run: |
+ yarn build
diff --git a/.github/workflows/superset-docs.yml b/.github/workflows/superset-docs-verify.yml
similarity index 81%
rename from .github/workflows/superset-docs.yml
rename to .github/workflows/superset-docs-verify.yml
index e1c2df7d12..f474a88157 100644
--- a/.github/workflows/superset-docs.yml
+++ b/.github/workflows/superset-docs-verify.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: dev@superset.apache.org
diff --git a/docs/src/components/SectionHeader.tsx b/docs/src/components/SectionHeader.tsx
index c868b4097a..10eedaa41c 100644
--- 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
index 72b4be2821..597f74f123 100644
--- 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>