This is an automated email from the ASF dual-hosted git repository.
diqiu50 pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/gravitino.git
The following commit(s) were added to refs/heads/main by this push:
new 719e51a5dd [#13461] improvement(connector): Bundle connector image
README into Trino/Flink/Spark images (#13470)
719e51a5dd is described below
commit 719e51a5dde2e0170814f3ebd5aa3802e5b75972
Author: geyanggang <[email protected]>
AuthorDate: Wed Sep 23 16:58:46 2026 +0800
[#13461] improvement(connector): Bundle connector image README into
Trino/Flink/Spark images (#13470)
### What changes were proposed in this pull request?
Add `COPY README.md /README.md` to the three connector image Dockerfiles
so the
connector-image usage documentation ships inside the image:
- `dev/docker/trino-connectors/Dockerfile`
- `dev/docker/flink-connectors/Dockerfile`
- `dev/docker/spark-connectors/Dockerfile`
The existing `/licenses` handling and the Trino version-band
`LICENSE`/`NOTICE`/`README.md` (brought in by `assembleTrinoConnector`
under
`/connectors/trino-*/`) are left unchanged. The new `/README.md` is the
connector-image README under `dev/docker/*-connectors/`, at a different
path,
so it does not conflict with the band README.
### Why are the changes needed?
The connector images currently only ship the connector packages, the
entrypoint
and `/licenses`; the image usage README is not included, so users cannot
read
install/usage docs from the image itself.
Fix: #13461
### Does this PR introduce _any_ user-facing change?
Yes. Users can now read the usage documentation from the image, e.g.
`docker run --rm --entrypoint cat <image> /README.md`.
### How was this patch tested?
Verified the `COPY README.md /README.md` line is present in all three
Dockerfiles, that each build context contains `README.md`, and that the
copy is
placed after `COPY licenses /licenses` and before the entrypoint. Built
a
connector image locally and confirmed `/README.md` is present alongside
the
existing `/licenses` and `/connectors` contents.
---
dev/docker/flink-connectors/Dockerfile | 3 +++
dev/docker/spark-connectors/Dockerfile | 3 +++
dev/docker/trino-connectors/Dockerfile | 3 +++
3 files changed, 9 insertions(+)
diff --git a/dev/docker/flink-connectors/Dockerfile
b/dev/docker/flink-connectors/Dockerfile
index 5448554747..d25a430d81 100644
--- a/dev/docker/flink-connectors/Dockerfile
+++ b/dev/docker/flink-connectors/Dockerfile
@@ -73,6 +73,9 @@ COPY --chmod=755 copy-connector.sh /copy-connector.sh
# --- licenses directory (LICENSE + NOTICE + third-party summary) ---
COPY licenses /licenses
+# --- Connector image usage documentation ---
+COPY README.md /README.md
+
# --- Drop source-control artifacts, OpenShift arbitrary UID compatibility,
# and a passwd entry for UID 1000 ---
RUN rm -f /licenses/.gitignore \
diff --git a/dev/docker/spark-connectors/Dockerfile
b/dev/docker/spark-connectors/Dockerfile
index 395e26a412..9960924952 100644
--- a/dev/docker/spark-connectors/Dockerfile
+++ b/dev/docker/spark-connectors/Dockerfile
@@ -75,6 +75,9 @@ COPY --chmod=755 copy-connector.sh /copy-connector.sh
# --- licenses directory (LICENSE + NOTICE + third-party summary) ---
COPY licenses /licenses
+# --- Connector image usage documentation ---
+COPY README.md /README.md
+
# --- Drop source-control artifacts, OpenShift arbitrary UID compatibility,
# and a passwd entry for UID 1000 ---
RUN rm -f /licenses/.gitignore \
diff --git a/dev/docker/trino-connectors/Dockerfile
b/dev/docker/trino-connectors/Dockerfile
index 11cfcbefa6..cf241f2bfd 100644
--- a/dev/docker/trino-connectors/Dockerfile
+++ b/dev/docker/trino-connectors/Dockerfile
@@ -73,6 +73,9 @@ COPY --chmod=755 copy-connector.sh /copy-connector.sh
# --- licenses directory (LICENSE + NOTICE + third-party summary) ---
COPY licenses /licenses
+# --- Connector image usage documentation ---
+COPY README.md /README.md
+
# --- Drop source-control artifacts, OpenShift arbitrary UID compatibility,
# and a passwd entry for UID 1000 ---
RUN rm -f /licenses/.gitignore \
