add yaml agent development skill#38382
Conversation
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request introduces a new documentation resource to assist developers working with the Apache Beam YAML SDK. It provides a centralized reference for project structure, environment configuration, and common development workflows, aiming to streamline the onboarding and troubleshooting process for contributors. Highlights
New Features🧠 You can now enable Memory (public preview) to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize the Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counterproductive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request adds a comprehensive development guide for the Apache Beam YAML SDK, detailing the project structure, environment setup, and testing procedures. Review feedback correctly identified a technical inaccuracy regarding the implementation of IO transforms and recommended clarifying the installation command to use repository-relative paths.
| - `standard_io.yaml` - Declarations of standard IO transforms and their mappings to providers. | ||
| - `standard_providers.yaml` - Configuration for standard providers (e.g., Java expansion services). | ||
| - `yaml_combine.py` - Implementations for aggregation and combining operations. | ||
| - `yaml_io.py` - Python implementations for builtin IOs (PubSub, BigQuery, Iceberg, etc.). |
There was a problem hiding this comment.
The description of yaml_io.py as containing "Python implementations" for IOs like Iceberg is inaccurate. Iceberg is implemented in Java and accessed via cross-language providers. yaml_io.py primarily contains the logic for the IO provider and mappings to various implementations.
| - `yaml_io.py` - Python implementations for builtin IOs (PubSub, BigQuery, Iceberg, etc.). | |
| - yaml_io.py - Mappings and logic for IO transforms (e.g., PubSub, BigQuery, Iceberg). |
| - `yaml_transform.py` - Core YAML expansion logic, parsing, and translation to Beam pipelines. | ||
|
|
||
| ## Environment Setup | ||
| Since Beam YAML is implemented within the Python SDK, the environment setup is identical to Python development. Refer to the `python-development` skill for details on using `pyenv` and installing in editable mode (`pip install -e .[gcp,test]`). |
There was a problem hiding this comment.
The pip install command should be executed from the sdks/python directory for the relative path . to be correct. Since the rest of this guide uses paths relative to the repository root, it is clearer to provide the command that works from the root.
| Since Beam YAML is implemented within the Python SDK, the environment setup is identical to Python development. Refer to the `python-development` skill for details on using `pyenv` and installing in editable mode (`pip install -e .[gcp,test]`). | |
| Since Beam YAML is implemented within the Python SDK, the environment setup is identical to Python development. Refer to the python-development skill for details on using pyenv and installing in editable mode (e.g., pip install -e sdks/python[gcp,test] from the root). |
|
Assigning reviewers: R: @shunping added as fallback since no labels match configuration Note: If you would like to opt out of this review, comment Available commands:
The PR bot will only process comments in the main thread (not review comments). |
1 participant
Please add a meaningful description for your change here
Thank you for your contribution! Follow this checklist to help us incorporate your contribution quickly and easily:
addresses #123), if applicable. This will automatically add a link to the pull request in the issue. If you would like the issue to automatically close on merging the pull request, commentfixes #<ISSUE NUMBER>instead.CHANGES.mdwith noteworthy changes.See the Contributor Guide for more tips on how to make review process smoother.
To check the build health, please visit https://github.com/apache/beam/blob/master/.test-infra/BUILD_STATUS.md
GitHub Actions Tests Status (on master branch)
See CI.md for more information about GitHub Actions CI or the workflows README to see a list of phrases to trigger workflows.