Skip to content

[FLINK-40165][ci] Add docs check to Github Actions CI stage#28769

Open
dalelane wants to merge 1 commit into
apache:masterfrom
dalelane:flink-40165-add-docs-check-to-gha-ci
Open

[FLINK-40165][ci] Add docs check to Github Actions CI stage#28769
dalelane wants to merge 1 commit into
apache:masterfrom
dalelane:flink-40165-add-docs-check-to-gha-ci

Conversation

@dalelane

Copy link
Copy Markdown
Contributor

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 dalelane#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

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>
@flinkbot

flinkbot commented Jul 17, 2026

Copy link
Copy Markdown
Collaborator

CI report:

Bot commands The @flinkbot bot supports the following commands:
  • @flinkbot run azure re-run the last Azure build

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants