Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 3 commits into from
Jan 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -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:
Expand Down Expand Up @@ -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]
29 changes: 29 additions & 0 deletions .github/workflows/superset-docs-verify.yml
Original file line number Diff line number Diff line change
@@ -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
2 changes: 1 addition & 1 deletion docs/src/components/SectionHeader.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ const StyledSectionHeaderH2 = styled(StyledSectionHeader)`
interface SectionHeaderProps {
level: any;
title: string;
subtitle?: string;
subtitle?: string | Element | React.ReactNode;
dark?: boolean;
}

Expand Down
1 change: 0 additions & 1 deletion docs/src/pages/community.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -217,7 +217,6 @@ const Community = () => {
</a>
}
description={<p className="description">{description}</p>}
role="group"
aria-label="Community link"
/>
</List.Item>
Expand Down
Loading