From afebe088370cb3170ff3147f7258c55224654096 Mon Sep 17 00:00:00 2001
From: Roy Nieterau <roy_nieterau@hotmail.com>
Date: Mon, 28 Aug 2023 16:23:36 +0200
Subject: [PATCH] Refactor to PublishValidationError to allow the RepairAction
 to work + provide informational report message

---
 .../plugins/publish/validate_shape_zero.py    | 30 +++++++++++++++++--
 1 file changed, 28 insertions(+), 2 deletions(-)

diff --git a/openpype/hosts/maya/plugins/publish/validate_shape_zero.py b/openpype/hosts/maya/plugins/publish/validate_shape_zero.py
index 7a7e9a0aeee..c7af6a60dbe 100644
--- a/openpype/hosts/maya/plugins/publish/validate_shape_zero.py
+++ b/openpype/hosts/maya/plugins/publish/validate_shape_zero.py
@@ -7,6 +7,7 @@
 from openpype.pipeline.publish import (
     ValidateContentsOrder,
     RepairAction,
+    PublishValidationError
 )
 
 
@@ -67,5 +68,30 @@ def process(self, instance):
 
         invalid = self.get_invalid(instance)
         if invalid:
-            raise ValueError("Shapes found with non-zero component tweaks: "
-                             "{0}".format(invalid))
+            raise PublishValidationError(
+                title="Shape Component Tweaks",
+                message="Shapes found with non-zero component tweaks: '{}'"
+                        "".format(", ".join(invalid)),
+                description=(
+                    "## Shapes found with component tweaks\n"
+                    "Shapes were detected that have component tweaks on their "
+                    "components. Please remove the component tweaks to "
+                    "continue.\n\n"
+                    "### Repair\n"
+                    "The repair action will try to *freeze* the component "
+                    "tweaks into the shapes, which is usually the correct fix "
+                    "if the mesh has no construction history (= has its "
+                    "history deleted)."),
+                detail=(
+                    "Maya allows to store component tweaks within shape nodes "
+                    "which are applied between its `inMesh` and `outMesh` "
+                    "connections resulting in the output of a shape node "
+                    "differing from the input. We usually want to avoid this "
+                    "for published meshes (in particular for Maya scenes) as "
+                    "it can have unintended results when using these meshes "
+                    "as intermediate meshes since it applies positional "
+                    "differences without being visible edits in the node "
+                    "graph.\n\n"
+                    "These tweaks are traditionally stored in the `.pnts` "
+                    "attribute of shapes.")
+            )