[FLINK-34486] Add documentation on how to add the shared utils as a submodule to the connector repo

• Type: Improvement
• Status: Open
• Priority: Major
• Resolution: Unresolved
• Affects Version/s: connector-parent-1.1.0
• Component/s: Connectors / Common
• Labels: starter
• Assignee: Unassigned
• Reporter: Matthias Pohl
• Created: 21/Feb/24 11:57
• Updated: 21/Feb/24 11:57

Description

apache/flink-connector-shared-utils:README.md doesn't state how a the shared utils shall be added as a submodule to a connector repository. But this is expected from within connector release documentation:

The following sections assume that the release_utils branch from flink-connector-shared-utils is mounted as a git submodule under tools/releasing/shared, you can update the submodule by running git submodule update --remote (or git submodule update --init --recursive if the submodule wasn't initialized, yet) to use latest release utils, you need to mount the flink-connector-shared-utils as a submodule under the tools/releasing/shared if it hasn't been mounted in the connector repository. See the README for details.

Let's update the README accordingly and add a link to README in the connector release documentation