feat: Update README with Docker Image Deployment Instructions and Enhance Release Details #39
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description:
This pull request updates the
README.md
file with new sections and enhancements to provide clearer guidance and improve the documentation for thedojo-beam-transforms
project. The following key changes are included in this PR:Docker Image Deployment Instructions:
Release Details:
2.58.1
) and the compatible Python versions (3.8
,3.9
,3.10
).Apache Beam SDK Update:
2.58.1
. This version includes several improvements but comes with specific warnings and known issues:io.kafka.ReadFromKafka
configured withcommit_offset_in_finalize
. This issue is tracked in Apache Beam GitHub issue #32196.GcsIO
, either directly or throughBigQueryIO
, may experience data corruption on Apache Beam Python SDK versions2.53.0
to2.58.1
. This issue is detailed in Apache Beam GitHub issue #32169.2.58.1
will be deprecated on August 16, 2025, as per the Google Cloud documentation.Table of Contents:
Rationale:
These updates enhance the usability and clarity of the project documentation, ensuring that users are well-informed about the deployment process and potential issues with the Apache Beam SDK. The README now provides comprehensive instructions for Docker image deployment and highlights critical information about the dependencies and versioning used in the
dojo-beam-transforms
project.