Enhancement/nuke openrv integration

.github/workflows/configuration.json

@@ -0,0 +1,89 @@
+{
+    "categories": [
+      {
+        "title": "## 🚀 Features",
+        "labels": ["feature"]
+      },
+      {
+        "title": "## 🐛 Fixes",
+        "labels": ["fix"]
+      },
+      {
+        "key": "tests",
+        "title": "## 🧪 Tests",
+        "labels": ["test"]
+      },
+      {
+        "title": "## 🧪 Tests and some 🪄 Magic",
+        "labels": ["test", "magic"],
+        "exclude_labels": ["no-magic"],
+        "exhaustive": true,
+        "exhaustive_rules": "false",
+        "empty_content": "- no matching PRs",
+        "rules": [
+          {
+            "pattern": "open",
+            "on_property": "status",
+            "flags": "gu"
+          }
+        ]
+      }
+    ],
+
+    // "ignore_labels": [
+    //   "ignore"
+    // ],
+    "sort": {
+      "order": "ASC",
+      "on_property": "mergedAt"
+    },
+    "template": "${{UNCATEGORIZED}}",
+    "pr_template": "- ${{TITLE}}\n   - PR: #${{NUMBER}}",
+    "empty_template": "- no changes",
+    "label_extractor": [
+      {
+        "pattern": "(.) (.+)",
+        "target": "$1",
+        "flags": "gu"
+      },
+      {
+        "pattern": "\\[Issue\\]",
+        "on_property": "title",
+        "method": "match"
+      }
+    ],
+    // "duplicate_filter": {
+    //   "pattern": "\\[ABC-....\\]",
+    //   "on_property": "title",
+    //   "method": "match"
+    // },
+    // "reference": {
+    //   "pattern": ".*\\ \\#(.).*",
+    //   "on_property": "body",
+    //   "method": "replace",
+    //   "target": "$1"
+    // },
+    // "transformers": [
+    //   {
+    //     "pattern": "[\\-\\*] (\\[(...|TEST|CI|SKIP)\\])( )?(.+?)\n(.+?[\\-\\*] )(.+)",
+    //     "target": "- $4\n  - $6"
+    //   }
+    // ],
+    // "trim_values": false,
+    // "max_tags_to_fetch": 200,
+    // "max_pull_requests": 200,
+    // "max_back_track_time_days": 365,
+    // "exclude_merge_branches": [
+    //   "Owner/qa"
+    // ],
+    "tag_resolver": {
+      "method": "semver",
+      "filter": {
+        "pattern": "api-(.+)",
+        "flags": "gu"
+      }
+    },
+    // "base_branches": [
+    //   "dev"
+    // ]
+}

.github/workflows/patch_build.yml

@@ -0,0 +1,62 @@
+name: 📦 Build Zip Patch
+
+on:
+  push:
+    tags:
+      - '*.*.*'
+      - '*.*.*-*'
+      - 'CI/*.*.*-*'
+  workflow_dispatch:
+    inputs:
+      name:
+        type: choice
+        description: Who to greet
+        options: 
+        - monalisa
+        - cschleiden
+      message:
+        required: true
+      use-emoji:
+        type: boolean
+        description: Include  emojis
+      environment:
+        type: environment
+jobs:
+  build-zip-patch:
+    runs-on: [self-hosted, ubuntu]
+
+    steps:
+
+    - name: 🚛 Checkout Code
+      uses: actions/checkout@v3
+      with:
+        fetch-depth: 0
+
+    # - name: "📝 Build Changelog"
+    #   id: changelog
+    #   uses: mikepenz/release-changelog-builder-action@v3.4.0
+    #   with:
+    #     # fromTag: "3.15.6"
+    #     # toTag: "3.15.8"
+    #     commitMode: true
+    #     failOnError: true
+    #     configuration: "configuration.json"
+    #   env:
+    #     GITHUB_TOKEN: ${{ secrets.QUAD_PUBLIC_GITHUB_TOKEN }}
+
+    - name: 🐍 Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: 3.9
+
+    - name: 🧵 Install Requirements
+      run: ./tools/create_env.sh && ./tools/fetch_thirdparty_libs.sh
+
+    - name: 🔨 Build
+      run: tools/create_zip.sh --path /prod/softprod/apps/openpype/REPOSITORY/
+
+    # - name: 💬 Message to Release chat
+    #   uses: julb/action-post-googlechat-message@v1
+    #   with:
+    #     message: ${{ steps.changelog.outputs.changelog }}
+    #     gchat_webhook_url: ${{ secrets.GCHAT_RELEASE_WEBHOOK_URL }}

.github/workflows/sync_fork.yml

@@ -0,0 +1,29 @@
+name: 🔄 Sync Fork
+
+on:
+  schedule:
+    - cron: '0 0 * * 1-5' # Monday to friday at 00:00
+  workflow_dispatch:
+
+jobs:
+  sync-code:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: tgymnich/fork-sync@v1.8
+        with:
+          token: ${{ secrets.QUAD_PUBLIC_GITHUB_TOKEN }}
+          base: develop
+          head: develop
+          pr_message: Automatic synchronization requires conflict resolution.
+          merge_method: rebase
+
+  sync-tags:
+    runs-on: ubuntu-latest
+    needs: sync-code
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          token: ${{ secrets.QUAD__PUBLIC_GITHUB_TOKEN }}
+          fetch-depth: 0
+      - run: |
+          git push origin --tags

openpype/hooks/pre_add_last_workfile_arg.py

@@ -26,7 +26,8 @@ class AddLastWorkfileToLaunchArgs(PreLaunchHook):
         "photoshop",
         "tvpaint",
         "substancepainter",
-        "aftereffects"
+        "aftereffects",
+        "openrv"
     ]
 
     def execute(self):

openpype/hooks/pre_ocio_hook.py

@@ -20,7 +20,8 @@ class OCIOEnvHook(PreLaunchHook):
         "maya",
         "nuke",
         "hiero",
-        "resolve"
+        "resolve",
+        "openrv"
     ]
 
     def execute(self):

openpype/hosts/nuke/api/pipeline.py

@@ -23,7 +23,7 @@
 )
 from openpype.pipeline.workfile import BuildWorkfile
 from openpype.tools.utils import host_tools
-
+from openpype.lib.applications import ApplicationManager
 from .command import viewer_update_and_undo_stop
 from .lib import (
     Context,
@@ -333,6 +333,8 @@ def _install_menu():
     # adding shortcuts
     add_shortcuts_from_presets()
 
+    # adding rv
+    add_rv_from_presets()
 
 def change_context_label():
     menubar = nuke.menu("Nuke")
@@ -359,10 +361,56 @@ def change_context_label():
         Context.context_label, label))
 
 
+def add_rv_from_presets():
+    rv_settings = get_current_project_settings()["openrv"]['openrv_nuke_integration']
+
+    if not rv_settings['rvnuke_enabled']:
+        return
+
+    if 'rvnuke_content_paths' not in rv_settings:
+        return
+
+    for rv_nuke_path in rv_settings['rvnuke_content_paths']:
+        if os.path.exists(rv_nuke_path):
+            nuke.pluginAddPath(rv_nuke_path)
+            log.info("RV Nuke path added: {}".format(rv_nuke_path))
+        else:
+            log.warning("RV Nuke path not found: {}".format(rv_nuke_path))
+
+    app_manager = ApplicationManager()
+    openrv_app = app_manager.find_latest_available_variant_for_group("openrv")
+    rv_exec_path = str(openrv_app.find_executable())
+
+    if not rv_exec_path:
+        return
+    try:
+        import rvNuke
+        rv_pref_panel = rvNuke.RvPreferencesPanel()
+        rv_pref_panel.rvPrefs.prefs["rvExecPath"] = rv_exec_path
+        rv_pref_panel.rvPrefs.saveToDisk()
+    except ImportError:
+        log.warning("rvNuke not found")
+
+    nuke.addOnCreate(add_rv_shortcut, nodeClass="Root")
+    return
+
+
+def add_rv_shortcut():
+    rv_global_settings = get_current_project_settings()["openrv"]
+    rv_nuke_settings = rv_global_settings['openrv_nuke_integration']
+    if rv_nuke_settings['rvnuke_open_in_rv_shortcut']:
+        menubar = nuke.menu("Nuke")
+        menu_item = menubar.findItem("RV/View in RV")
+        menu_item.setShortcut("Alt+v")
+        menu_item.setShortcut(rv_nuke_settings['rvnuke_open_in_rv_shortcut'])
+        log.info("Adding Shortcut `{}` to `{}`".format(
+            'Open in RV',
+            rv_nuke_settings['rvnuke_open_in_rv_shortcut']))
+
+
 def add_shortcuts_from_presets():
     menubar = nuke.menu("Nuke")
     nuke_presets = get_current_project_settings()["nuke"]["general"]
-
     if nuke_presets.get("menu"):
         menu_label_mapping = {
             "create": "Create...",

openpype/hosts/openrv/__init__.py

@@ -0,0 +1,10 @@
+from .addon import (
+    OpenRVAddon,
+    OPENRV_ROOT_DIR
+)
+
+
+__all__ = (
+    "OpenRVAddon",
+    "OPENRV_ROOT_DIR"
+)

openpype/hosts/openrv/addon.py

@@ -0,0 +1,33 @@
+import os
+from openpype.modules import OpenPypeModule
+from openpype.modules.interfaces import IHostAddon
+
+OPENRV_ROOT_DIR = os.path.dirname(os.path.abspath(__file__))
+
+
+class OpenRVAddon(OpenPypeModule, IHostAddon):
+    name = "openrv"
+    host_name = "openrv"
+
+    def initialize(self, module_settings):
+        self.enabled = True
+
+    def add_implementation_envs(self, env, app):
+        """Modify environments to contain all required for implementation."""
+        # Set default environments if are not set via settings
+        defaults = {
+            "OPENPYPE_LOG_NO_COLORS": "True"
+        }
+        for key, value in defaults.items():
+            if not env.get(key):
+                env[key] = value
+
+    def get_launch_hook_paths(self, app):
+        if app.host_name != self.host_name:
+            return []
+        return [
+            os.path.join(OPENRV_ROOT_DIR, "hooks")
+        ]
+
+    def get_workfile_extensions(self):
+        return [".rv"]

openpype/hosts/openrv/api/__init__.py

@@ -0,0 +1,10 @@
+# -*- coding: utf-8 -*-
+"""OpenRV OpenPype host API."""
+
+from .pipeline import (
+    OpenRVHost
+)
+
+__all__ = [
+    "OpenRVHost"
+]

openpype/hosts/openrv/api/commands.py

@@ -0,0 +1,34 @@
+import logging
+
+import rv
+from openpype.pipeline.context_tools import get_current_project_asset
+
+log = logging.getLogger(__name__)
+
+
+def reset_frame_range():
+    """ Set timeline frame range.
+    """
+    asset_doc = get_current_project_asset()
+    asset_name = asset_doc["name"]
+    asset_data = asset_doc["data"]
+
+    frame_start = asset_data.get("frameStart")
+    frame_end = asset_data.get("frameEnd")
+
+    if frame_start is None or frame_end is None:
+        log.warning("No edit information found for {}".format(asset_name))
+        return
+
+    rv.commands.setFrameStart(frame_start)
+    rv.commands.setFrameEnd(frame_end)
+    rv.commands.setFrame(frame_start)
+
+
+def set_session_fps():
+    """ Set session fps.
+    """
+    asset_doc = get_current_project_asset()
+    asset_data = asset_doc["data"]
+    fps = float(asset_data.get("fps", 25))
+    rv.commands.setFPS(fps)