Automated Reviews in Unreal

[antirotor]

Creating reviews is now tightly bound to user activity - publishing render process will create reviewable in AYON.But for larger projects, or projects shared using perforce, or by other means with third parties not using AYON, this might not be enough.

Problems to solve:

• review needs to be somehow triggered:
  • user action (button)
  • event (like commit to VCS) (AY-7231_Unreal events to AYON #175)
  • scheduled (every day)
• determining what to use for review
  • predetermined name of sequencer in settings (AYON specific)
  • sequencer with metadata (is there any way to add metadata to the sequencer?)
  • collections - all sequencers in "review" collection for example
    
• where to create the review
  • review created by the active unreal session (for user action / interactive trigger) (this would need some local tools (AY-7232_Review tools as part of Unreal Plugin #174)
  • on machine triggered by some AYON service (farm) - event originates in studio A but machine in studio B is creating/publishing review
• publishing of created review

---

This must works on environments without AYON - where project in Unreal can connect to some AYON instance (using key stored within the project - ynput/ayon-backend#450). Unreal has all the tools to communicate with the server. it can create events that can be processed. The easiest way would be to have a service that will be triggered by event sent from Unreal (or in case of scheduling, it will create it's own) - that service would in turn create the jobs on farm. For that, we need to pass at least the context of the review (folder path, task) and the name of the sequencer.

[moonyuet]

In terms of how the review to be triggered, I agree with most of the points.

• Button for review is the straightforward way to create and publish review, by no means.

• For event for VCS, we need to have more discussion/experiment on which callback to use for triggering the review.

• Scheduling time is possible, but it can only be done after refactoring on our rendering workflow.

• I also think that perhaps it's good idea to add some additional options which triggers review (e.g. on/off toggle) in the publisher? Once the review options in the publisher are disabled, Ayon won't create reviewable for that render instances.

Determining what to use for review

• predetermined name of sequencer in settings (AYON specific) <- Just one or it can be more than one? And there is possibility that artists/users would rename the sequencer(s) in Unreal.

• sequencer with metadata (is there any way to add metadata to the sequencer?) <- We can create data asset to store the name/object path of the sequencers

• collections - all sequencers in "review" collection for example -> This is the easiest way to manage and get the sequencers for reviews.