Skip to content

increment_workfile

IncrementWorkfile

Bases: ContextPlugin, OptionalPyblishPluginMixin

Increment the current workfile.

Saves the current scene with an increased version number.

Source code in client/ayon_photoshop/plugins/publish/increment_workfile.py
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
class IncrementWorkfile(pyblish.api.ContextPlugin, OptionalPyblishPluginMixin):
    """Increment the current workfile.

    Saves the current scene with an increased version number.
    """

    label = "Increment Workfile"
    order = pyblish.api.IntegratorOrder + 9.0
    hosts = ["photoshop"]
    optional = True

    def process(self, context: pyblish.api.Context):
        if not self.is_active(context.data):
            return

        errored_plugins = get_errored_plugins_from_context(context)
        if errored_plugins:
            raise RuntimeError(
                "Skipping incrementing current file because publishing failed."
            )

        current_filepath: str = context.data["currentFile"]
        host: IWorkfileHost = registered_host()
        current_filename = os.path.basename(current_filepath)
        save_next_version(
            description=(
                f"Incremented by publishing from {current_filename}"
            ),
            # Optimize the save by reducing needed queries for context
            prepared_data=SaveWorkfileOptionalData(
                project_entity=context.data["projectEntity"],
                project_settings=context.data["project_settings"],
                anatomy=context.data["anatomy"],
            )
        )
        new_scene_path = host.get_current_workfile()

        self.log.info(f"Incremented workfile to: {new_scene_path}")