feat: Process export to YAML

[toby-coleman]

Summary

Adds Process.dump method, allowing the user to export their model to a YAML config file for use in the CLI.

Changes

• Adds `process.dump("model.yaml")
• Updates schema validation to support.

[gemini-code-assist]

Summary of Changes

Hello @toby-coleman, I'm Gemini Code Assist¹! 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 the capability to export a Process model's configuration to a YAML file, streamlining its use with the command-line interface. This feature is supported by necessary updates to the underlying data schemas and includes new validation logic to ensure data integrity during serialization. The changes also include an updated tutorial and a dedicated integration test to verify the new functionality.

Highlights

• New Process.dump method: A new dump method has been added to the Process class, enabling users to export their process configurations to a YAML file. This facilitates easier use of models within the CLI.
• Enhanced Schema Validation: Schema validation has been updated across ConnectorSpec and ProcessSpec to properly handle the new YAML export capabilities and ensure data consistency when models are serialized and deserialized.
• New Integration Test for YAML Export: An integration test has been added to confirm that a Process object can be successfully exported to YAML and then accurately reconstructed, validating the integrity of the serialized data.
• Documentation Update: The hello-world tutorial documentation has been updated with a new tip, guiding users on how to leverage the Process.dump method to export their code-defined models to YAML.

Using Gemini Code Assist

The 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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in issue comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize 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 .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. 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.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request introduces a dump method to the Process class, allowing model configurations to be exported to YAML files. This is a great feature for CLI usage and model sharing. The changes include the dump method implementation, necessary updates to schema validation to support deserialization from YAML, and corresponding tests and documentation.

My review focuses on improving the maintainability of the new schema validator. Overall, the changes are well-implemented and tested.

[codecov]

Codecov Report

❌ Patch coverage is 89.47368% with 2 lines in your changes missing coverage. Please review.

Files with missing lines	Patch %	Lines
plugboard/schemas/process.py	71.42%	1 Missing and 1 partial ⚠️

📢 Thoughts on this report? Let us know!