Simple headless publishing in ayon

I think we are going to deviate abit from the topic’s title above and having a broder discussion about how publishing in AYON.

Personally, I think the current publish workflow requires some training till you get use to it as it’s full of details. also, it provides a comprehensive settings which affect how this system work.

The publish process is following pyblish where you:

  1. Create instances using creators.
  2. Run the publish logic which runs the (collect, validate, extract, integrate) plugins sequentially in order.

Although this post Openpype Publish process - Development guide is written in OpenPype flavor, but the workflow/process is the same.

I think if it’s your first time, imo, I’d recommend to

  1. pick your facorite DCC to start inspecting the publish flow
  2. publish anything, check the details tab in the publisher and check the log of each plugin.
  3. have a look on creators and publish plugins scripts in the DCC addon.
  4. Check the pyblish debug stepper tool to get a hint about what happens behined the scenes.

The goal here is to learn more about how this system behaves and then you can start tweaking the publish flow a bit. for reference, you can add more metadata related to your workflow.

Unfortunately, I don’t think we have type hints for the instance object and the minimum data it should contain.