feat: add docs check to pull requests#2
Closed
dalelane wants to merge 1 commit into
Closed
Conversation
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. Signed-off-by: Dale Lane <dale.lane@uk.ibm.com>
XComp
reviewed
Jul 16, 2026
| s3_secret_key: ${{ secrets.IT_CASE_S3_SECRET_KEY }} | ||
|
|
||
| docs_check: | ||
| name: "Docs 404 check" |
There was a problem hiding this comment.
We don't do a filtering here, hm? The docs check will always run, even if there were no docs changes. But I guess that's a minor thing. 🤔
I checked with Azure: We have the following two subsequent nightly runs:
- #20260715.4 with flink-ci/flink-mirror@7757f2c being the HEAD
- #20260716.4 with flink-ci/flink-mirror@eda168e being the HEAD
The following command shows that we're not touching any docs code. Still, the docs check was performed in #20260716.4.
$ git log 7757f2c..eda168e --oneline --name-only
eda168ef69b [FLINK-40138][tests] Drive JUnit 5 lifecycle when generating migration test snapshots (#28739)
flink-test-utils-parent/flink-migration-test-utils/pom.xml
flink-test-utils-parent/flink-migration-test-utils/src/main/java/org/apache/flink/test/migration/JUnit5TestEnvironment.java
flink-test-utils-parent/flink-migration-test-utils/src/main/java/org/apache/flink/test/migration/SnapshotGeneratorUtils.java
So, let's prepare the create a dedicated Jira subtask (with the context) and prepare this PR to make it mergable.
Owner
Author
|
created https://issues.apache.org/jira/browse/FLINK-40165 and raised apache#28769 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.
Example of a successful run: https://github.com/dalelane/flink/actions/runs/28648668507