Just thought I'd share a technique for artists to include comments with their publishes.
The gist of it is to add the comment within a scene, collect it when publishing and discard it right after.
- Create a node
comment, and add the comment to the "notes" field of the attribute editor.
- Alternatively, if your
instance's are already encapsulated in a node, say an Object Set, add the comment in it's "notes" field.
- Create any node with a textfield, call it
- Alternatively, add the comment to the output-node's "Label".
- On any node, create a "Label" or "String" attribute.
The same goes for any other host, such as Softimage, Modo or Fusion.
Finally, after a successful publish, remove the attribute/node from the author's scene automatically via a plug-in, such as an Integrator, or post-validator. That way, you could include a validator that looks for a comment and either warns about it not being there, or enforces that one must exist.
Modifying the scene during publishing is generally considered bad, but considering the transient nature of a comment and how it is related to the event itself, it's safe, future-proof and encouraged.
As an added bonus, storing the comment in the scene means publishing can be done offline, via the command-line, or distributed. Simply package up the scene, including a comment, and send it off!
This behaviour is much encouraged, as it enables a native interface between the host and data used for publishing, and transcends usage in just Pyblish. I would consider it good practice to develop a simple comment-GUI to help artists put the comment in. Perhaps something that launches prior to Pyblish, when the artists hit the "Publish" button.
Food for thought.