SG-43421 Add Flow AM desktop publish hooks (Phase 1)#220
Open
chenm1adsk wants to merge 4 commits into
Open
Conversation
Move Flow AM publish hooks from tk-config-flowam POC into upstream tk-desktop as a lift-and-shift with no logic changes. Added hooks/flowam/: - collector_desktop.py: Desktop-specific collector extending base collector - publish_to_flow_desktop.py: Desktop-specific publish to Flow AM hook
3 tasks
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #220 +/- ##
==========================================
- Coverage 24.81% 24.71% -0.11%
==========================================
Files 68 68
Lines 3970 3970
==========================================
- Hits 985 981 -4
- Misses 2985 2989 +4
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Restructure the Flow AM publisher hooks to live under hooks/tk-multi-publish2/flowam/ instead of hooks/flowam/. This matches the layout used by other Toolkit engines (tk-nuke, tk-maya), which group their app-specific hooks by consumer app first, then by variant. Also add class-level docstrings to both hooks documenting their dependency on the tk-multi-publish2 base hooks and the expected hook chain string in the config. Changes: - hooks/flowam/collector.py -> hooks/tk-multi-publish2/flowam/collector.py - hooks/flowam/publish_to_flow.py -> hooks/tk-multi-publish2/flowam/publish_to_flow.py
Contributor
carlos-villavicencio-adsk
left a comment
There was a problem hiding this comment.
Looks good to me. It's only about code move, so I didn't spend much time reviewing the code.
julien-lang
requested changes
May 28, 2026
Member
julien-lang
left a comment
There was a problem hiding this comment.
Please add typing info for the new methods
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.
Summary
Move Flow AM desktop publish hooks from
tk-config-flowamPOC into upstreamtk-desktopas a lift-and-shift with no logic changes.Added
hooks/tk-multi-publish2/flowam/:collector.py- Desktop-specific collector; blocks DCC file extensions and readsTK_FLOWAM_REVISION_ID_*env var set by Loaderpublish_to_flow.py- Desktop-specific publish to Flow AM leaf hookBoth hooks inherit from the Flow AM base hooks in
tk-multi-publish2(see PR shotgunsoftware/tk-multi-publish2#217) and are wired up via the hook chain intk-config-flowam.Note:
The hooks under
hooks/flowam/are dormant by default.The hooks are only wired in via a custom config (
tk-config-flowam), which acts as a feature flag for the Flow AM workflow. Users on any other configuration are unaffected by this PR.This is the first iteration of the migration. Once the Flow AM framework is fully migrated, the custom config requirement will be removed and these hooks will trigger automatically when a MEDM project is detected.
Testing