[ManagedIO] Single source of truth for ManagedIO configs #34720
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
liferoad
reviewed
Apr 24, 2025
| @@ -688,6 +688,11 @@ project.tasks.register("generateExternalTransformsConfig") { | |||
| dependsOn(":sdks:python:generateExternalTransformsConfig") | |||
| } | |||
|
|
|||
| // Generates the Managed IO Beam web page | |||
| project.tasks.register("generateManagedIOPage") { | |||
| dependsOn(":sdks:python:generateManagedIOPage") | |||
There was a problem hiding this comment.
do we run this regularly or triggered by some tasks?
There was a problem hiding this comment.
I added a test to the beam_PreCommit_Xlang_Generated_Transforms workflow.
The test regenerates and compares with the existing doc. If there's a mismatch, the test fails and tells the developer to run this command and commit the updates
|
Checks are failing. Will not request review until checks are succeeding. If you'd like to override that behavior, comment |
…ged_config_observability
|
Please check the failed workflows before merging it. |
liferoad
approved these changes
Apr 24, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This creates a source of truth for ManagedIO configs, based on two yaml files under
sdks/java/managed/src/main/resources/:available_configs.yamlconfig_aliases.yaml(1) provides a list of available configs that should be made public, while (2) provides aliases for existing config fields.
A fleshed out Beam website page is generated according to the configuration in these two files, displaying a summary of each Managed IO's configuration as well as a more detailed view with descriptions. All of this information is pulled from individual SchemaTransforms.