Skip to content

Commit 4c48d9d

Browse files
authored
chore(CI): get docs building on ALL branches. (apache#26854)
1 parent db00591 commit 4c48d9d

File tree

4 files changed

+36
-12
lines changed

4 files changed

+36
-12
lines changed

.github/workflows/superset-docs.yml .github/workflows/superset-docs-deploy.yml

+6-10
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,11 @@
1-
name: Docs
1+
name: Docs Deployment
22

33
on:
44
push:
55
paths:
66
- "docs/**"
77
branches:
8-
- 'master'
9-
pull_request:
10-
paths:
11-
- "docs/**"
12-
types: [synchronize, opened, reopened, ready_for_review]
8+
- "master"
139

1410
jobs:
1511
config:
@@ -51,9 +47,9 @@ jobs:
5147
env:
5248
API_TOKEN_GITHUB: ${{ secrets.SUPERSET_SITE_BUILD }}
5349
with:
54-
source-directory: './docs/build'
55-
destination-github-username: 'apache'
56-
destination-repository-name: 'superset-site'
57-
target-branch: 'asf-site'
50+
source-directory: "./docs/build"
51+
destination-github-username: "apache"
52+
destination-repository-name: "superset-site"
53+
target-branch: "asf-site"
5854
commit-message: "deploying docs: ${{ github.event.head_commit.message }} (apache/superset@${{ github.sha }})"
5955
user-email: [email protected]
+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: Docs Testing
2+
3+
on:
4+
pull_request:
5+
paths:
6+
- "docs/**"
7+
types: [synchronize, opened, reopened, ready_for_review]
8+
jobs:
9+
build-deploy:
10+
name: Build & Deploy
11+
runs-on: ubuntu-20.04
12+
defaults:
13+
run:
14+
working-directory: docs
15+
steps:
16+
- name: "Checkout ${{ github.ref }} ( ${{ github.sha }} )"
17+
uses: actions/checkout@v3
18+
with:
19+
persist-credentials: false
20+
submodules: recursive
21+
- name: yarn install
22+
run: |
23+
yarn install --check-cache
24+
- name: yarn typecheck
25+
run: |
26+
yarn typecheck
27+
- name: yarn build
28+
run: |
29+
yarn build

docs/src/components/SectionHeader.tsx

+1-1
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ const StyledSectionHeaderH2 = styled(StyledSectionHeader)`
9696
interface SectionHeaderProps {
9797
level: any;
9898
title: string;
99-
subtitle?: string;
99+
subtitle?: string | Element | React.ReactNode;
100100
dark?: boolean;
101101
}
102102

docs/src/pages/community.tsx

-1
Original file line numberDiff line numberDiff line change
@@ -217,7 +217,6 @@ const Community = () => {
217217
</a>
218218
}
219219
description={<p className="description">{description}</p>}
220-
role="group"
221220
aria-label="Community link"
222221
/>
223222
</List.Item>

0 commit comments

Comments
 (0)