Set version tags on publish

client/ayon_core/plugins/publish/collect_version_tags.py

@@ -0,0 +1,61 @@
+import pyblish.api
+
+from ayon_core.lib import EnumDef
+from ayon_core.pipeline.publish import AYONPyblishPluginMixin
+
+
+class CollectVersionTags(
+    pyblish.api.InstancePlugin,
+    AYONPyblishPluginMixin
+):
+    """Collect Version Tags
+
+    Provides a selectable list of tags for the user. Selected tags are stored
+     in the instance metadata and applied to the Version Entity during
+     integration.
+    """
+
+    order = pyblish.api.CollectorOrder + 0.499
+    label = "Collect Version Tags"
+    settings_category = "core"
+
+    enabled = False
+
+    def process(self, instance):
+
+        attr_values = self.get_attr_values_from_data(instance.data)
+        version_tags = attr_values.get("version_tags", [])
+
+        if not version_tags:
+            return
+
+        self.log.debug(f"Adding tags: {version_tags}")
+        tags = instance.data.get("versionTags")
+        if tags is None:
+            tags = set()
+        elif not isinstance(tags, set):
+            tags = set(tags)
+
+        tags.update(version_tags)
+        instance.data["versionTags"] = tags
+        self.log.debug(f"Collected version tags: {tags}")
+
+    @classmethod
+    def get_attr_defs_for_instance(cls, create_context, instance):
+        project_entity = create_context.get_current_project_entity()
+        items = [tag["name"] for tag in project_entity["tags"]]
+        if not items:
+            plugin_attributes = instance.publish_attributes.get(cls.__name__)
+            if plugin_attributes is not None:
+                plugin_attributes.pop("version_tags", None)
+            return []
+
+        return [
+            EnumDef(
+                "version_tags",
+                label="Version Tags",
+                multiselection=True,
+                items=items,
+                tooltip="Set these tags to versions",
+            )
+        ]

client/ayon_core/plugins/publish/integrate.py

@@ -498,6 +498,23 @@ def prepare_version(
         host_name = instance.context.data["hostName"]
         version_data["host_name"] = host_name
 
+        tags = instance.data.get("versionTags")
+        if tags is not None:
+            # Check if tags is an iterable.
+            if not isinstance(tags, (list, tuple, set)):
+                raise PublishError(
+                    "Tags must be an iterable."
+                    f" Instead got type {type(tags)}"
+                )
+            # Error if not all are string.
+            if not all(isinstance(tag, str) for tag in tags):
+                raise PublishError(
+                    "Version tags must be an iterable of strings. "
+                    f"Got: {type(tags)}"
+                )
+            # Force the type to be list for the new_version_entity call.
+            tags = list(tags)
+
         version_entity = new_version_entity(
             version_number,
             product_entity["id"],
@@ -506,6 +523,7 @@ def prepare_version(
             data=version_data,
             attribs=version_attributes,
             entity_id=version_id,
+            tags=tags,
         )
 
         if existing_version:

client/ayon_core/plugins/publish/integrate_hero_version.py

@@ -243,13 +243,20 @@ def integrate_instance(
         if old_version:
             entity_id = old_version["id"]
 
+        tags = instance.data.get("versionTags")
+        if tags is not None:
+            # Tags contents are checked at earlier step "IntegrateAsset"
+            # Force the type to be list for the new_version_entity call.
+            tags = list(tags)
+
         new_hero_version = new_version_entity(
             - src_version_entity["version"],
             src_version_entity["productId"],
             task_id=src_version_entity.get("taskId"),
             data=copy.deepcopy(src_version_entity["data"]),
             attribs=copy.deepcopy(src_version_entity["attrib"]),
             entity_id=entity_id,
+            tags=tags,
         )
 
         if old_version:

server/settings/publish_plugins.py

@@ -98,6 +98,10 @@ class CollectFramesFixDefModel(BaseSettingsModel):
     )
 
 
+class CollectVersionTagsModel(BaseSettingsModel):
+    enabled: bool = SettingsField(False)
+
+
 def usd_contribution_layer_types():
     return [
         {"value": "asset", "label": "Asset"},
@@ -1432,6 +1436,13 @@ class PublishPuginsModel(BaseSettingsModel):
         default_factory=CollectHierarchyModel,
         title="Collect Hierarchy"
     )
+    CollectVersionTags: CollectVersionTagsModel = SettingsField(
+        title="Collect Version Tags",
+        description=(
+            "Provides a selectable list of tags for the user in the"
+            " publisher."
+        )
+    )
     ValidateEditorialAssetName: ValidateBaseModel = SettingsField(
         default_factory=ValidateBaseModel,
         title="Validate Editorial Asset Name"
@@ -1660,6 +1671,9 @@ class PublishPuginsModel(BaseSettingsModel):
     "CollectHierarchy": {
         "edit_shot_attributes_on_update": True,
     },
+    "CollectVersionTags": {
+        "enabled": False
+    },
     "ValidateEditorialAssetName": {
         "enabled": True,
         "optional": False,