Remove instance version number given as argument to add_preview and let Kitsu determine revision number#128
Conversation
|
@Burital I'm not sure if just removing it is the nicest approach - it'd make the revision unrelated to the AYON version alltogether - I wonder if instead it could try to match IF version does not exist on server yet, otherwise increment it? (but maybe that's also too confusing?) Seems consensus in community seems to be acceptable of this change - so, fine with me. |
|
I'll hold off merging for a few days to give time to others to provide some feedback, but looks good to me. |
|
I understand the point for this PR but I think removing the functionality to match Kitsu and Ayon's version number can cause some comunication problems. For me the client checks Kitsu and then say "I like version 8 the best", now what version does the client talk about? In case I also write the version in the publish text it doesn't mean the client see it or use that version number. The only way I can see Kitsus version number drift apart from Ayons is if someone uploads something outside of Ayons pipeline. Of course it's ok to do but that can also then break the pipeline, like #127 Best would be if this could be an option in the settings so the user can uncheck to sync Ayon's version number. What do we think about that? |
BigRoy
left a comment
There was a problem hiding this comment.
Best would be if this could be an option in the settings so the user can uncheck to sync Ayon's version number. What do we think about that?
Please implement to make this an exposed setting.
The exposed setting has been implemented in this PR, it is set to True by default to avoid breaking pipelines that already rely on this synchronization, a description was added to describe best what potential errors this setting aims to solve with revision and version matching. |
BigRoy
left a comment
There was a problem hiding this comment.
LGTM - just a minor note on the description of the setting.
Co-authored-by: Roy Nieterau <roy_nieterau@hotmail.com>
Changelog Description
Remove instance version number given as argument to
add_previewand let Kitsu determine revision number, resolves #127Additional Info
This PR aims to solve #127 by simply not providing the
"version"as revision number toadd_previewand letting Kitsu assign this number itself.If
instance.data["version"]was passed as an argument it was for Ayon and Kitsu to more accurately reflect each other, however several different kinds of products can create reviewables for a same task in Kitsu, and a product or instance's version number may not be an accurate basis for the latest revision preview number. Also, as described in the issue, you can add revision previews directly through Kitsu and Ayon being unaware of it.When no
revisionargument is given, Kitsu will automatically give it the right n+1 version number and will avoid conflicts, this is what was done here.For these reasons it seems this is not that important to keep the revision number absolutely synchronized to a product's version and removing this argument can also prevent some issues.
Testing notes:
You can follow the steps described in #127 to see the change in behavior.