You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@flink.apache.org by "dalelane (via GitHub)" <gi...@apache.org> on 2026/07/17 12:40:27 UTC

[PR] [FLINK-40165][ci] Add docs check to Github Actions CI stage [flink]

dalelane opened a new pull request, #28769:
URL: https://github.com/apache/flink/pull/28769

   ## What is the purpose of the change
   
   Adding a new workflow to make sure docs aren't broken as part of the Github Actions CI pipeline for pull requests.
   
   The goal is to achieve parity with the docs_404_check job that is included in the ci stage of the Azure Pipelines
   azure-pipelines.yml which I'm treating as a reference implementation.
   
   ## Brief change log
   
   Added a new docs check workflow, based on the Azure Pipelines equivalent.
   
   ## Verifying this change
   
   Manually triggered the Github Actions pipeline in my own fork
   
   (see https://github.com/dalelane/flink/pull/2)
   
   ## Does this pull request potentially affect one of the following parts:
   
     - Dependencies (does it add or upgrade a dependency): no
     - The public API, i.e., is any changed class annotated with `@Public(Evolving)`: no
     - The serializers: no 
     - The runtime per-record code paths (performance sensitive): no 
     - Anything that affects deployment or recovery: JobManager (and its components), Checkpointing, Kubernetes/Yarn, ZooKeeper: no 
     - The S3 file system connector: no 
   
   ## Documentation
   
     - Does this pull request introduce a new feature? no
     - If yes, how is the feature documented? not applicable 
   
   ##### Was generative AI tooling used to co-author this PR?
   
   no


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

Re: [PR] [FLINK-40165][ci] Add docs check to Github Actions CI stage [flink]

Posted by "dalelane (via GitHub)" <gi...@apache.org>.
dalelane commented on PR #28769:
URL: https://github.com/apache/flink/pull/28769#issuecomment-5108552966

   @snuyanzin sorry about that! added it now in 9e2e8d5ffc1125ed1bd1667ec44f4fc6d5556910 


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

Re: [PR] [FLINK-40165][ci] Add docs check to Github Actions CI stage [flink]

Posted by "XComp (via GitHub)" <gi...@apache.org>.
XComp commented on code in PR #28769:
URL: https://github.com/apache/flink/pull/28769#discussion_r3629558576


##########
.github/workflows/docs-check.yml:
##########
@@ -0,0 +1,49 @@
+# 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@v5
+        with:
+          persist-credentials: false

Review Comment:
   good point 👍 



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

Re: [PR] [FLINK-40165][ci] Add docs check to Github Actions CI stage [flink]

Posted by "snuyanzin (via GitHub)" <gi...@apache.org>.
snuyanzin commented on code in PR #28769:
URL: https://github.com/apache/flink/pull/28769#discussion_r3621672569


##########
.github/workflows/docs-check.yml:
##########
@@ -0,0 +1,49 @@
+# 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@v5
+        with:
+          persist-credentials: false

Review Comment:
   do we really need the full check out here?
   Or may be sparse checkout should be enough?



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

Re: [PR] [FLINK-40165][ci] Add docs check to Github Actions CI stage [flink]

Posted by "snuyanzin (via GitHub)" <gi...@apache.org>.
snuyanzin commented on PR #28769:
URL: https://github.com/apache/flink/pull/28769#issuecomment-5088724589

   lgtm 
   may be one little nit: would it make sense to bump `actions/checkout@v5` to `actions/checkout@v7` as in all other workflows it is version 7?


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

Re: [PR] [FLINK-40165][ci] Add docs check to Github Actions CI stage [flink]

Posted by "flinkbot (via GitHub)" <gi...@apache.org>.
flinkbot commented on PR #28769:
URL: https://github.com/apache/flink/pull/28769#issuecomment-5003434597

   <!--
   Meta data
   {
     "version" : 1,
     "metaDataEntries" : [ {
       "hash" : "597c12e539575048b1dedd271224f6eb99c3f231",
       "status" : "UNKNOWN",
       "url" : "TBD",
       "triggerID" : "597c12e539575048b1dedd271224f6eb99c3f231",
       "triggerType" : "PUSH"
     } ]
   }-->
   ## CI report:
   
   * 597c12e539575048b1dedd271224f6eb99c3f231 UNKNOWN
   
   <details>
   <summary>Bot commands</summary>
     The @flinkbot bot supports the following commands:
   
    - `@flinkbot run azure` re-run the last Azure build
   </details>


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

Re: [PR] [FLINK-40165][ci] Add docs check to Github Actions CI stage [flink]

Posted by "snuyanzin (via GitHub)" <gi...@apache.org>.
snuyanzin commented on PR #28769:
URL: https://github.com/apache/flink/pull/28769#issuecomment-5103178252

   @dalelane seems I missed one thing: you use sparse checkout in PR's workflow, however not yet in nightly, can you please also make it using in nightly and we can merge it then?


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

Re: [PR] [FLINK-40165][ci] Add docs check to Github Actions CI stage [flink]

Posted by "dalelane (via GitHub)" <gi...@apache.org>.
dalelane commented on code in PR #28769:
URL: https://github.com/apache/flink/pull/28769#discussion_r3639259483


##########
.github/workflows/docs-check.yml:
##########
@@ -0,0 +1,49 @@
+# 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@v5
+        with:
+          persist-credentials: false

Review Comment:
   nice idea - added in 9d581584e7cb3254a019d2bcc332cd47456de205 - thanks



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

Re: [PR] [FLINK-40165][ci] Add docs check to Github Actions CI stage [flink]

Posted by "snuyanzin (via GitHub)" <gi...@apache.org>.
snuyanzin merged PR #28769:
URL: https://github.com/apache/flink/pull/28769


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org