YN-0022 Adds batchgroup publishing workflow - MVP#84
Closed
jakubjezek001 wants to merge 54 commits into
Closed
Conversation
jakubjezek001
added
sponsored
Adds ability to generate batchgroup product for shot. - Creates a new creator for batchgroup products. - Adds a boolean setting to toggle batchgroup export. - Uses "workfile" product type and names for the batchgroup.
creation plugin. Uses `self.presets.get()` directly within property definitions, removing the need for a local variable. This makes the code more readable and maintainable.
Adds a plugin to extract Batchgroup product data to create and update batch groups in Flame. Updates the collect batchgroup plugin to set the task name and attach task data. Removes the collect batchgroup directory plugin.
- Defines models for output node properties and task attachment. - Introduces `CollectBatchgroupModel` for managing batchgroup settings. - Includes default settings for `CollectBatchgroup` plugin.
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds support for batchgroup product creation in the Flame integration, allowing users to generate batchgroup workfile products for shots. The implementation includes settings configuration, creator plugins, and collection/extraction logic for batch groups.
Key changes:
- Added settings models for batchgroup configuration including output node properties and task attachment
- Introduced new creator plugin for editorial batchgroup instances
- Implemented collection and extraction plugins for batchgroup processing
Reviewed Changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 8 comments.
Show a summary per file
| File | Description |
|---|---|
| server/settings/publish_plugins.py | Added OutputNodePropertiesModel, AttachToTaskModel, and CollectBatchgroupModel settings with default configuration |
| server/settings/create_plugins.py | Added export_batchgroup boolean field to enable batchgroup export in shot clip creation |
| client/ayon_flame/plugins/publish/exctract_batchgroup.py | New plugin that extracts batchgroup product data and creates batch groups in Flame |
| client/ayon_flame/plugins/publish/collect_shots.py | Added flameAddTasks to copy to instance attributes |
| client/ayon_flame/plugins/publish/collect_batchgroup.py | New plugin that collects batchgroup workfile products for shots |
| client/ayon_flame/plugins/create/create_shot_clip.py | Added EditorialBatchgroupInstanceCreator class and batchgroup handling logic, refactored preset access |
Comments suppressed due to low confidence (1)
client/ayon_flame/plugins/publish/collect_batchgroup.py:5
- Import of 'deepcopy' is not used.
from copy import deepcopy
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
validation of setting keys in collector families not needed at creator
Updates the property processing logic to convert values from settings to integers when possible. Also adds static method decorator to shot task dir path.
- Updates batchgroup extraction to handle templated paths for output nodes, enhancing flexibility. - Converts values to their appropriate types. - Utilizes `Pathlib` for robust path management. - Improves settings configuration for output node properties.
Renames the `name` key to `task_name` within `attach_to_task` data. This change provides clearer semantic meaning when defining or linking tasks during batchgroup publishing. Adjusts the `ExtractBatchgroup` plugin's order to `ExtractorOrder` to ensure it executes correctly within the Pyblish extraction phase.
Adds 'clip' family to the batchgroup instance. This modification ensures that batchgroup instances are correctly identified as 'clip' type. This is required for publishing batch as workfile functionality.
Adds logging for property settings during batch extraction to aid in debugging and ensure values are correctly assigned. This enhances visibility into the property assignment process.
- Improves batchgroup extraction with anatomy data. - Adds root to anatomy data for workfile publishing. - Uses StringTemplate for strict formatting. - Includes logging for attribute setting. - Improves value conversion with better type handling.
Simplifies batch node attribute setting with contextlib.suppress to handle potential errors. This improves code readability and robustness by suppressing expected RuntimeErrors during attribute setting, avoiding unnecessary error logging.
jakubjezek001
changed the title
Extracts batch group data into a JSON format for easier workfile publishing. - Converts batch group content to JSON. - Uses staging directory for temporary storage. - Adds folder path to batchgroup name. - Updates Batchgroup extraction.
rdelillo
reviewed
Feb 10, 2026
Contributor
There was a problem hiding this comment.
Do not review this. This not new code, but it appears as a new because of the naming change.
Member
Author
|
I am assuming we could perhaps merge it, right @rdelillo ? |
4 tasks
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
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.
Changelog Description
Batchgroup product publishing workflow.
closes #67
Additional info
Add task(shot) andbatch group tasksettingsFollow up questions
LoadBatchgrouplogic that loads the batch nodes within current batch. Should we make more options available ?Testing notes:
Create/Update batchgroupsoption enabled