This is an automated email from the ASF dual-hosted git repository.
snuyanzin pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/flink.git
The following commit(s) were added to refs/heads/master by this push:
new 12bd86b104c [FLINK-40165][ci] Add docs check to Github Actions CI stage
12bd86b104c is described below
commit 12bd86b104cc4cb0556c296353826e4b2572ed07
Author: Dale Lane <[email protected]>
AuthorDate: Wed Jul 29 06:06:32 2026 +0100
[FLINK-40165][ci] Add docs check to Github Actions CI stage
---
.github/workflows/docs-check.yml | 52 ++++++++++++++++++++++++++++++++++++++++
.github/workflows/nightly.yml | 15 ++++++++++++
2 files changed, 67 insertions(+)
diff --git a/.github/workflows/docs-check.yml b/.github/workflows/docs-check.yml
new file mode 100644
index 00000000000..09c4e38353c
--- /dev/null
+++ b/.github/workflows/docs-check.yml
@@ -0,0 +1,52 @@
+# 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.
+
+# Runs the Hugo docs build and checks for broken links. Triggered only when
+# docs/** files are changed, acting as a PR gate for documentation changes.
+#
+# This is the GHA equivalent of the docs_404_check job in the Azure Pipelines
+# ci stage (tools/azure-pipelines/build-apache-repo.yml). Azure gates the check
+# on pr_contains_docs_changes; here the workflow-level paths filter achieves
the
+# same effect without needing a per-step skip condition.
+
+name: "Docs 404 check (beta)"
+
+on:
+ pull_request:
+ paths:
+ - 'docs/**'
+ workflow_dispatch:
+
+concurrency:
+ group: ${{ github.workflow }}-${{ github.head_ref || github.ref }}
+ cancel-in-progress: true
+
+permissions: read-all
+
+jobs:
+ docs-check:
+ name: "Docs 404 check"
+ runs-on: ubuntu-24.04
+ steps:
+ - name: "Flink Checkout"
+ uses: actions/checkout@v7
+ with:
+ persist-credentials: false
+ sparse-checkout: |
+ docs
+ tools/ci/docs.sh
+
+ - name: "Build docs and check for broken links"
+ run: ./tools/ci/docs.sh
diff --git a/.github/workflows/nightly.yml b/.github/workflows/nightly.yml
index 70c6f8d09e6..22441ebf98b 100644
--- a/.github/workflows/nightly.yml
+++ b/.github/workflows/nightly.yml
@@ -77,6 +77,21 @@ jobs:
s3_access_key: ${{ secrets.IT_CASE_S3_ACCESS_KEY }}
s3_secret_key: ${{ secrets.IT_CASE_S3_SECRET_KEY }}
+ docs_check:
+ name: "Docs 404 check"
+ runs-on: ubuntu-24.04
+ steps:
+ - name: "Flink Checkout"
+ uses: actions/checkout@v7
+ with:
+ persist-credentials: false
+ sparse-checkout: |
+ docs
+ tools/ci/docs.sh
+
+ - name: "Build docs and check for broken links"
+ run: ./tools/ci/docs.sh
+
build_python_wheels:
name: "Build Python Wheels on ${{ matrix.os_name }}"
runs-on: ${{ matrix.os }}
