geyanggang opened a new pull request, #13470:
URL: https://github.com/apache/gravitino/pull/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.
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to