Skip to content

[hotfix][docs] Bump externalized connector docs refs to latest minor releases#28095

Open
Dennis-Mircea wants to merge 2 commits intoapache:masterfrom
Dennis-Mircea:hotfix/update-jdbc-reference
Open

[hotfix][docs] Bump externalized connector docs refs to latest minor releases#28095
Dennis-Mircea wants to merge 2 commits intoapache:masterfrom
Dennis-Mircea:hotfix/update-jdbc-reference

Conversation

@Dennis-Mircea
Copy link
Copy Markdown

@Dennis-Mircea Dennis-Mircea commented May 3, 2026

What is the purpose of the change

Several externalized connectors had published new minor releases that were not yet picked up by docs/setup_docs.sh, so the rendered pages on the Flink master docs site (https://nightlies.apache.org/flink/flink-docs-master/docs/connectors/datastream/...) were lagging behind the upstream connector documentation. This pull request refreshes the connector docs refs to track each connector's latest released minor branch, consistent with how the rest of the script is already pinned (Kafka v4.0, Elasticsearch v4.0, HBase v4.0, AWS v6.0, ...).

Brief change log

docs/setup_docs.sh:

  • flink-connector-jdbc: v3.1v4.0 (latest released: v4.0.0)
  • flink-connector-pulsar: v4.0v4.1 (latest released: v4.1.0)
  • flink-connector-gcp-pubsub: v3.0v3.1 (latest released: v3.1.0)

The remaining connectors (elasticsearch, aws, cassandra, rabbitmq, mongodb, opensearch, kafka, hbase, prometheus, hive) were verified to already track their latest released minor branch and are left untouched.

Verifying this change

This change is a trivial documentation-tooling fix without any test coverage.

It was manually verified by:

  • Listing the upstream branches and tags of every apache/flink-connector-* repo, confirming that the three bumped refs each correspond to an existing release branch with a published GA tag, and that the remaining ten connectors already track their latest minor branch.
  • Wiping the connector cache (rm -rf docs/themes/connectors docs/tmp) and re-running docs/setup_docs.sh, confirming each bumped connector's docs are now sourced from the new branch.
  • Rendering the docs locally and inspecting the JDBC, Pulsar, and GCP Pub/Sub DataStream pages, which now match the upstream contents of v4.0, v4.1, and v3.1 respectively.

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?
  • Yes (please specify the tool below)

@flinkbot
Copy link
Copy Markdown
Collaborator

flinkbot commented May 3, 2026

CI report:

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

Copy link
Copy Markdown
Contributor

@spuru9 spuru9 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unrelated to the topic of the PR, some of the other packages seem to have updates as well like pulsar and opensearch. Would be nice to update them as well, or I can go through the list and raise a PR. WDYT?

@github-actions github-actions Bot added the community-reviewed PR has been reviewed by the community. label May 3, 2026
@Dennis-Mircea Dennis-Mircea changed the title [hotfix][docs] Bump flink-connector-jdbc docs ref from v3.1 to v4.0 [hotfix][docs] Bump externalized connector docs refs to latest minor releases May 4, 2026
@Dennis-Mircea Dennis-Mircea requested a review from spuru9 May 4, 2026 07:20
@Dennis-Mircea
Copy link
Copy Markdown
Author

Unrelated to the topic of the PR, some of the other packages seem to have updates as well like pulsar and opensearch. Would be nice to update them as well, or I can go through the list and raise a PR. WDYT?

Thanks for the review, good point! I tackle them as part of this PR.

Comment thread docs/setup_docs.sh
integrate_connector_docs gcp-pubsub v3.0
integrate_connector_docs gcp-pubsub v3.1
integrate_connector_docs mongodb v2.0
integrate_connector_docs opensearch v1.2
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

opensearch also seems to be having v2.0

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the suggestion! Unfortunately I don't think this bump can be applied here.

integrate_connector_docs uses git clone --single-branch --branch ${ref} (see docs/setup_docs.sh#L31), so the second argument needs to be an existing branch in the connector repo, matching the vX.Y convention used by the other entries.

Looking at apache/flink-connector-opensearch, only v1.0, v1.1, and v1.2 branches exist and there is no v2.0 branch yet. v2.0.0 is published as a release tag, but using it would break the branch-based convention the rest of the script follows.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, Thank you for the explanation. Noted.

@Dennis-Mircea Dennis-Mircea requested a review from spuru9 May 6, 2026 08:11
Copy link
Copy Markdown
Contributor

@spuru9 spuru9 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

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

Labels

community-reviewed PR has been reviewed by the community.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants