Skip to content

Commit 23a933c

Browse files
committed
[docs] Add GitHub Action to automatically check broken links in docs
1 parent f5beb87 commit 23a933c

File tree

1 file changed

+43
-0
lines changed

1 file changed

+43
-0
lines changed

.github/workflows/docs-check.yaml

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
################################################################################
2+
# Copyright (c) 2025 Alibaba Group Holding Ltd.
3+
#
4+
# Licensed under the Apache License, Version 2.0 (the "License");
5+
# you may not use this file except in compliance with the License.
6+
# You may obtain a copy of the License at
7+
#
8+
# http://www.apache.org/licenses/LICENSE-2.0
9+
#
10+
# Unless required by applicable law or agreed to in writing, software
11+
# distributed under the License is distributed on an "AS IS" BASIS,
12+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
# See the License for the specific language governing permissions and
14+
# limitations under the License.
15+
################################################################################
16+
17+
# This workflow is meant for checking broken links in the documentation.
18+
name: Checks Documentation
19+
on:
20+
pull_request:
21+
branches: [main, release-*, ci-*]
22+
paths:
23+
- 'website/**'
24+
25+
jobs:
26+
test-deploy:
27+
runs-on: ubuntu-latest
28+
defaults:
29+
run:
30+
working-directory: ./website
31+
steps:
32+
- uses: actions/checkout@v4
33+
with:
34+
fetch-depth: 0
35+
- name: Generate versioned docs
36+
run: ./build_versioned_docs.sh
37+
- uses: actions/setup-node@v4
38+
with:
39+
node-version: 18
40+
- name: Install dependencies
41+
run: npm install
42+
- name: Test build website
43+
run: npm run build -- --no-minify

0 commit comments

Comments
 (0)