[hotfix][docs] Bump externalized connector docs refs to latest minor releases#28095
[hotfix][docs] Bump externalized connector docs refs to latest minor releases#28095Dennis-Mircea wants to merge 2 commits intoapache:masterfrom
Conversation
spuru9
left a comment
There was a problem hiding this comment.
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. |
| 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 |
There was a problem hiding this comment.
opensearch also seems to be having v2.0
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
Ok, Thank you for the explanation. Noted.
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 (Kafkav4.0, Elasticsearchv4.0, HBasev4.0, AWSv6.0, ...).Brief change log
docs/setup_docs.sh:flink-connector-jdbc:v3.1→v4.0(latest released:v4.0.0)flink-connector-pulsar:v4.0→v4.1(latest released:v4.1.0)flink-connector-gcp-pubsub:v3.0→v3.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:
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.rm -rf docs/themes/connectors docs/tmp) and re-runningdocs/setup_docs.sh, confirming each bumped connector's docs are now sourced from the new branch.v4.0,v4.1, andv3.1respectively.Does this pull request potentially affect one of the following parts:
@Public(Evolving): noDocumentation
Was generative AI tooling used to co-author this PR?