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

[CI] Fix dead links error #3751

Merged
merged 3 commits into from
Jun 12, 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
68 changes: 68 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
#
# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.
# The ASF licenses this file to You under the Apache License, Version 2.0
# (the "License"); you may not use this file except in compliance with
# the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#


on:
push:
branches:
- dev
- release-*
- dev-*
paths:
- '**.md'
pull_request:
paths:
- '**.md'


name: Docs


concurrency:
group: doc-${{ github.event.pull_request.number || github.ref }}
cancel-in-progress: true


jobs:
dead-link:
if: github.repository == 'apache/incubator-streampark'
name: Dead links
runs-on: ubuntu-latest
timeout-minutes: 20
steps:
- uses: actions/checkout@v3
- run: sudo npm install -g [email protected]
- run: |
for file in $(find . -name "*.md"); do
markdown-link-check -c .dlc.json -q "$file"
done
result:
name: Docs
runs-on: ubuntu-latest
timeout-minutes: 30
needs:
- dead-link
if: always()
steps:
- name: Status
run: |
if [[ ${{ contains(needs.*.result, 'failure') }} == 'true' || ${{ contains(needs.*.result, 'cancelled') }} == 'true' ]]; then
echo "Docs check Failed!"
exit 1
else
echo "Docs check Success!"
fi
12 changes: 0 additions & 12 deletions .github/workflows/maven.yml
Original file line number Diff line number Diff line change
Expand Up @@ -61,18 +61,6 @@ jobs:
submodules: true
- name: Check codestyle
run: ./mvnw -B -q -nsu checkstyle:check spotless:check
dead-link:
if: github.repository == 'apache/incubator-streampark'
name: Dead links
runs-on: ubuntu-latest
timeout-minutes: 20
steps:
- uses: actions/checkout@v3
- run: sudo npm install -g [email protected]
- run: |
for file in $(find . -name "*.md"); do
markdown-link-check -c .dlc.json -q "$file"
done
build:
name: "maven-compile (java-${{ matrix.java }})"
runs-on: ubuntu-latest
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
[![Twitter Follow](https://img.shields.io/twitter/follow/ASFStreamPark?label=follow&logo=x&style=for-the-badge)](https://twitter.com/ASFStreamPark)

**[Website](https://streampark.apache.org)**  |  
**[Official Documentation](https://streampark.apache.org/docs/intro)**  |  
**[Official Documentation](https://streampark.apache.org/docs/get-started/intro)**  |  
**[FAQ](https://github.com/apache/incubator-streampark/issues/507)**

![](https://streampark.apache.org/image/dashboard-preview.png)
Expand Down Expand Up @@ -61,7 +61,7 @@
- [Start with Docker](docker/README.md)
- [Start with Kubernetes](helm/README.md)

Click [Official Documentation](https://streampark.apache.org/docs/user-guide/quick-start) for more information
Click [Official Documentation](https://streampark.apache.org/docs/framework/quick-start) for more information

## 🔨 How to Build

Expand All @@ -71,7 +71,7 @@ cd incubator-streampark
./build.sh
```

🗄 Details:how to [Development](https://streampark.apache.org/docs/user-guide/development)
🗄 Details:how to [Development](https://streampark.apache.org/docs/development/development)

## 🧑‍💻 Downloads

Expand Down
2 changes: 1 addition & 1 deletion docker/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,4 @@ docker-compose up -d

http://localhost:10000

#### [more detail](https://streampark.apache.org/docs/user-guide/docker-deployment)
#### [more detail](https://streampark.apache.org/docs/get-started/docker-deployment)
Loading