Shotgun Basic Configuration v1.1.1

We are excited to release v1.1 of our integrations. This release includes a whole new take on our default configuration, updates to our new publisher, and updates to how the communication between Shotgun Desktop and Shotgun Web works.

Our default configuration has been updated to use the new Publisher, to take advantage of the new Software entity in Shotgun, and to make updating easier via a new organization. These changes allow a seamless transition for people using our integrations from running without a configuration to running with one.

We have also added new features to our new Publisher which make editing settings across multiple selections easier and give you the ability to embed custom UI for different types of publishes. Additionally we have updated the default hooks for the publisher so that they cover the functionality from the old default configuration while moving the engine specific logic into the engine itself.

The protocol for how Shotgun Desktop works with Shotgun Web has been updated. We have optimized the protocol so anybody running tools from within Shotgun should see a significant improvement in how quickly those menus are populated (note that we will need to recache the menus, which will happen when somebody first uses the update). The commands themselves now come from the tk-shotgun instance in the environment returned by the pick_environment core hook, which allows much more flexibility in deciding what menu items should show up where.

The new default configuration

The initial release of our out of the box integrations had a few features that were available as long as your project did not have a custom configuration. With our new default configuration, all the new functionality is available along with everything that was in our old configuration. This includes:

• An update to our project configuration wizard to make the new configuration available while preserving the ability to keep on using the tried and true configuration that we've had for years.
• A new directory structure that organizes the configuration into easier to find and easier to update files.
• An updated pick_environment hook that deprecates the use of the old shotgun_*.yml environment files.
• An update to use the new tk-multi-publisher2, with updated hooks that have been moved into the app and engines. The updated hooks are compatible with how the publisher works without a configuration, but adds in the extra functionality that becomes available once you have a configuration (such as the ability to publish our custom Nuke and Houdini nodes).
  • The new hooks support publishing to a location specified via a template.
  • The new hooks are implemented in their corresponding engine (e.g. in tk-maya for Maya).

Publisher updates

We've finished up some features that will make our new publisher more powerful and easier to use:

• You can now add custom UI to a type of publish to give artists the power to control aspects of the publish.
• It is now possible to set common settings (such as thumbnail and description) across multiple publish items at the same time.
• Toolkits let you know the details about warnings and errors without needing to switch over to the log view.

Websocket protocol updates

Last but not least, with this release we are enabling an update to the protocol that Shotgun Web uses to populate its action menus and that implements local file linking. The protocol updates speed up the way we populate these menus and implements a more flexible environment lookup. Now rather than looking for an environment corresponding to the Shotgun entity type a menu is displaying (such as shotgun_asset.yml) we use the pick environment core hook to find an environment containing an instance of the tk-shotgun engine and use the configuration of that engine to populate the menu. For example, you can now have a different launchers for Asset versus Shot tasks, or different launchers per pipeline step.

The old protocol is still available via an environment variable (SHOTGUN_ENABLE_LEGACY_BROWSER_INTEGRATION_WORKAROUND) if you want to compare the old behavior to the new. Note that the old protocol requires shotgun_asset.yml style environment files to populate the menus in Shotgun, which the new default protocol does not have. This fallback is only compatible with the legacy configuration.

Additional features

• Path cache optimizations. Removed inner loop for secondary entities and batched find queries into smaller chunks. [44807]
• synchronize_folders command was looking at every FilesystemLocation entity on the site, causing large sync times when there were a lot of entities. This optimization ensures that performing a full sync of the path cache now only considers FilesystemLocation entities that belong to the current project. [44508]
• Introduced the SHOTGUN_DISABLE_APPSTORE_ACCESS environment variable to disable all attempts to talk to the Shotgun app store. [44140]
• Updated pipeline_configuration.yml, shotgun.yml, interpreter_*.cfg, tank, and tank.bat for compatibility with Rez style environment management. [43297]

Fixed bugs

• Previously, when an unhandled exception bubbled up, we replied to the web app with the full exception stack. This fix ensures we reply with a general error message and log the full exception. If debug logging is turned on, we do still reply with the full exception. [42770]
• Nuke read node frame ranges were not set when loaded from the loader app when templates were not available. This fix ensures we correctly determine the start/end frame of an image sequence, regardless of whether a template can be used to parse the file name or not. [44569]
• unregister_folders command failed when unregistered a large amount of folders. This fix resolves that issue by batching up any large deletions into batched sql queries where 200 items are deleted at a time. [44931]
• v0000 files were incorrectly being published as v1. This fix publishes the correct name. [43560]
• Files with UTF-8 characters were not supported. This fix enables the publishing of files with UTF-8 characters. [43826]
• Descriptors had no flexibility in where they could be cached. This fix introduced the SHOTGUN_BUNDLE_CACHE_PATH environment variable to allow control over where descriptors are cached. [44757]
• Hook templates were breaking. This fix ensures hook templates from run properly. [45071]

Shotgun Basic Configuration v1.1.0

What’s new?

Defaults to bootstrap for getting actions, path cache optimization, and bug fixes.

Features/Polish

• Defaults to bootstrapping SGTK when getting actions for the Toolkit action menu in the Shotgun web app. The "legacy workaround" is still available, but is now behind an environment variable that requires an opt in. [44081]
• Path cache optimizations. Removed inner loop for secondary entities and find queries are batched into smaller chunks. [44807]

Bugs

• Previously, when an unhandled exception bubbled up, we replied to the web app with the full exception stack. This fix ensures we reply with a general error message and log the full exception. If debug logging is turned on, we do still reply with the full exception. [42770]
• synchronize_folders command was looking at every FilesystemLocation entity on the site, causing large sync times when there were a lot of entities. This fix ensures that performing a full sync of the path cache now only considers FilesystemLocation entities that belong to the current project. [44508]
• Nuke read node frame ranges were not set when loaded from the loader app when templates were not available. This fix ensures we correctly determine the start/end frame of an image sequence, regardless of whether a template can be used to parse the file name or not. [44569]
• unregister_folders command failed when unregistered a large amount of folders. This fix resolves that issue by batching up any large deletions into batched sql queries where 200 items are deleted at a time. [44931]

Shotgun Basic Configuration v1.0.45

What’s new?

Shotgun API updates with optimized pagination, added support for Maya 2018 and some bug fixes.

Features/Polish

• Updated to Shotgun API v3.0.34. The notable feature is optimized pagination, which improves query performance in certain situations. [44389]
• Added support for Maya 2018. [44161]

Bugs

• Toolkit didn’t properly clean up URLs typed in by the user. This fix keeps URLs clean. [43390]
• When working in a sandbox configuration in a project using a shared core, if a context change occurred as part of a file-open operation, the current pipeline configuration would be reverted back to Primary. This fix ensures your current pipeline configuration is not changed. [44926]

Shotgun Basic Configuration v1.0.44

What's new?

Fixed an important regression introduced in Shotgun Integration v1.0.43, where users were no longer able to launch applications from a global entity page.

Bugs

• Users were no longer able to launch applications from a global entity page. [44847]

Shotgun Basic Configuration v1.0.43

What's new?

Improved compatibility with Houdini 16, tk-core and apps improvements and bug fixes for different engines.

Features/polish

• Fixes to improve compatibility with Houdini 16. [40555]
• Added style sheet file watchers for interactive styling when developing apps. [40852]
• Shotgun Panel and Loader2 apps now redirect to the Media App page when clicking on the "play" icon on a Version. [43996]
• Improved logging on tank commands. [44167]

Bugs

• push_config failure can leave target config in a broken state. This fix ensures that the target pipeline configuration is not corrupted and is always available in its original folder or as a backup. [41460]
• The documentation link in the apps info sidebar wasn't working. This fix ensures that the documentation page opens after you click on the 'Documentation' button. [43063]
• Nuke 11 was crashing on close on Linux. This fix ensures that no more crashes happen on close. [44154]
• Multiple Shotgun menus can appear when sgtk is disabled. This fix prevents duplicate Shotgun menus when sgtk is disabled. [44166]
• The Shotgun menu wasn't restored properly after sgtk was in a disabled state. This fix ensures the Shotgun menu gets regenerated successfully. [44253]
• The method show_panel() did not return a widget instance. This fix ensures we are now returning it correctly. [44271]

Shotgun Basic Configuration v1.0.42

What's new?

Shotgun API updates to add direct S3 upload. Added support for Nuke 11, bug fixes for NUKE_PATH environment variable, Shotgun Panel, and standalone publishes.

Features/polish

• Updated to the Shotgun API v3.0.33. Notable features being added include direct S3 upload and follow API updates. [42677]
• Added support for Nuke 11. [42783]
• Improved core update message to specify the newer version of Toolkit. [43927]

Bugs

• The latest version of tk-nuke v0.7.0 no longer keeps the user set paths on the NUKE_PATH env var when launching Nuke. This fix adds to them rather than overwrites them. [43239]
• Manual updates to tk-shell v0.5.2 and tk-shotgun v0.5.3 caused a standalone publishes issue if Publish2 app was launched from a web browser or from command line. This fix ensures there is no issue. [43545]
• Publishes were not displaying for Versions in the Shotgun Panel. This fix displays Versions. [43795]

Shotgun Basic Configuration v1.0.41

What's new?

Integrations now work without an internet connection. Bug fixes for the Shotgun web app integration. Improvements to stability and resiliency.

Features/polish

• Modified the backup logic in Bootstrap so that it doesn’t keep an endless number of tk-core backups. [41418]
• Disabled the logout feature from the Shotgun Menu when the Maya plugin runs in Shotgun integration. [41524]
• Demoted info message to debug. This was causing info popups in the Shotgun engine and should
  really be debug rather than info. [42873]
• Added support for tabs in Shotgun Desktop. [43528]
• Applied Toolkit standard styling to custom panels in Shotgun Desktop. [43719]

Bugs

• Users couldn’t enter into a project if its core version was higher than the one used by Shotgun Desktop. This fix ensures users can enter their projects. [42679]
• Subprocesses would not inherit the bundle cache from the parent, which led to inefficient re-caching of bundles and prevented Shotgun integrations from working in offline mode. This fix enabled Shotgun integration workflow in offline mode. [42966]
• The Shotgun Desktop about box was not showing up when using a locked site config. This fix ensures the about box appears. [43224]
• Empty cache files led to error messages. This fix handles empty cache files gracefully. [43236]
• If a user had more than one instance of an app, then it failed to display all instances of the app after a context change and only displayed the first instance. This fix displays all instances of the app. [43403]
• If one of the apps in an environment raised an error during initialization, the environment didn’t populate any items in Shotgun menus. This fix ensures that all other menu items still show up. [43032]
• The Publish2 app was querying Shotgun unnecessarily when selecting items in the publish list. This fix prevents the unnecessary queries and speeds up user interaction. [43803]

Shotgun Basic Configuration v1.0.39

Features/Polish

• Set Framerange app added to Shotgun Basic Configuration. [41726]
• Publisher 2 app added to Shell Engine. [42793]
• Better handling for screenshots on Linux when Imagemagick is not installed. The built-in QT based approach is being used as a fallback. [42736]
• Removed use of tag_list for app store logic to comply with upcoming deprecation of that feature. [43276]

Bugs

• An error appeared in the browser console when opening a design page. This fix ensures there is no error. [42933]
• Menu items were taking a long time to cache. This fix centralizes YML file data lookup and caches the resulting data, reducing the amount of file IO required by the browser integration and greatly improving speed when dealing with configs that live on network file servers. [43057]
• Menu items for some entity types were not displaying. If a config contains shotgun_xxx.yml environment files, this fix ensures that the menu items from those environment files will show up. [43058]
• Task entities received actions configured for either Shot or Asset types, depending on which the specific Task was linked to. This was the case even if a specific shotgun_task.yml file existed in the config. This fix resolves Task entity cache keys when the websocket code path is used to get actions. [43060]
• Toolkit did not properly launch an application into the correct pipeline configuration. This fix ensures applications opens in the right pipeline configuration. [42198]
• The sg descriptor latest lookups was not working correctly. This fix ensures omitting the version number or using the "latest" keyword now works. [43137]