-
Notifications
You must be signed in to change notification settings - Fork 10
Release Notes
Welcome to the release notes for this Framework. Below you will find an overview of all the changes we did for each release. We try to be as detailed as possible and include all bugs we have fixed, features we have added and things that may have changed. If you have questions about a particular release, don't hesitate to contact our support team!
2024-Oct-30
- Package Python modules
2024-Oct-22
- Updates cryptography to 43.0.1
- Updates pyOpenSSL to 24.2.1 (required for cryptography)
- Fixes CVE-2024-6119
- Fixes CVE-2024-4603
- Fixes CVE-2024-2511
2024-Sep-9
- import six replaced by sgutils for ensure_* funcs
- Add Python 3.11 modules
2024-Aug-13
- Update certifi to 2024.7.4
- Update setuptools to 70.0.0
- Improve error handling
2024-May-9
Update idna to 3.7
2024-Mar-26
Rebranding component for Flow Production Tracking
2024-Feb-27
- Upgrade Cryptography to 42.0.4
- Add binary requirements for Python 3.10
- Combined multiple macOS architectures for zope and CFFI binaries
2024-Jan-22
- Cryptography 41.0.3 module uses
cp37-abi3-manylinux_2_28_x86_64WHEEL. This requires glibc 2.28 and breaks desktop menu items on CentOS7. This version fixes this by explicitly installing amanylinux_2_17compatible WHEEL on Linux platforms.
2023-Aug-30
- Fixes CVE-2022-40897 regarding setuptools module
2023-Aug-21
- Automate internal dependency updates.
- Updates Cryptography to 41.0.3.
- Updates Certifi to 2023.7.22.
- Replace cgi module with the html module to support the escape method.
2023-May-26
Updates Cryptography to 39.0.1.
2023-Jan-12
Updates some third-party libraries, dropping support for python 2.7
Note: Since this version this framework will not work anymore with Python 2.
2022-Apr-12
Adds Python 3.9 compatibility and security-related updates.
2021-Nov-30
Replacing shotgunsoftware urls with Autodesk Knowledge Network and ShotGrid Developer Documentation pages.
2021-Sept-21
Updates some third-party libraries, refresh the certificates and improves the process for updating dependencies.
Details:
- Add recent versions of python 3.7 for azure pipeline
- Replace windows, mac and linux binaries and file structure for python 2.7 and 3.7
- Replace python 2.7 and 3.7 sources
- Replace build folder with newer packages
- Fix small issue in the creation of bin folder in mac
- Add an improvement in windows and linux binary installation scripts
2021-Jun-02
Rebranded to ShotGrid
2021-Apr-13
Adds official support for Playlist entities, and more gracefully handles unsupported entity types.
2021-Jan-21
Fixes an infinite loop bug when caching actions.
Details:
If the tk-shotgun engine was configured to have no apps, or the result of caching the actions for tk-shotgun on a given environment resulted in no actions being generated, it would continuously try to re-cache the actions. This fixes that issue.
2020-Dec-8
Switches from using the support email alias to pointing to the support site
2020-Sep-02
Fixed a Python 3 issue where the browser integration could not generate a self-signed certificate.
2020-Aug-07
Removed the addition of the sgtk path to PYTHONPATH before calling execute_command and get_commands scripts.
Details:
Solves a problem where launching Maya from desktop was leading to the incorrect sgtk path being set in PYTHONPATH causing issues with core-hook path resolution.
2020-Jul-17
Fixes a bug where trying to cache actions for an unsupported entity creates null values in the database instead of skipping it.
2020-Jul-16
Switched to using sgtk.util.json.load to avoid unicode in python2
2020-Jul-14
Adds Python 3 compatibility and fixes some related bugs.
Details:
- Made the server python3 compatible
- Fixed an issue with the custom FileDialog and PySide2
- Added Azure automation
- Added an integration test
- Moved the database actions from the cache_commands script to api_v2 and renamed cache_commands to get_commands
- Reduced the amount of time api_v2 keeps a DB connection open to avoid race conditions on the DB lock
- Added logging of any errors from the execute_command method so it can be properly reported in the webapp popup
2020-Apr-07
Updates server backend.
Fixes a crash when launching a project using Python 3 in Shotgun Desktop.
Details:
Note that while this framework does not crash the project anymore when launching it with Python 3, the browser integration is currently not compatible with it. Any attempt to launch a command from the browser will result in a stack trace in the browser and/or the Shotgun Desktop's console.
2020-Jan-08
Fixes an issue where a browser could reject the shotgunlocalhost.com certificate.
2019-Sep-12
Updates webserver backend.
2018-Oct-29
Updates some third-party libraries and fixes a pair of issues around project filtering with the Software entity.
Details:
The two most notable fixes for project filtering are:
- fixes the project filtering of software with no engines associated
- fixes the project filtering when two software with the same engine use different project restrictions
This release works in conjunction with the
v.0.10.2release oftk-multi-launchapp. This other release is required for these fixes to work.
2018-Sep-4
Updated some third-party librairies used by the framework.
2018-Mar-12
Removed unnecessary files that sometimes turned into filenames longer than 260 characters on Windows.
2018-Feb-20
Tweaks an error message that's raised to the web app.
2017-Nov-08
Fixes a bug when a config does not have a root path on local storage.
Details:
This issue is raised when dealing with uploaded configs that might not yet have been downloaded to local storage. Rather than an unhandled exception being raised, we now log and continue gracefully.
2017-Nov-03
Implements asynchronous cache validation and recaching and fixes a sys.path bug.
Details:
Cache validation and recaching now occurs asynchronously. This introduces a potential to return an old set of menu actions to the caller, but only for as long as the caching subprocess takes to run. This is an intentional regression in favor of performance. The only time we now block when caching is when there's a complete cache miss and we have no actions to return immediately. A sys.path bug is also addressed, which ensures that the correct tk-core/sgtk is imported in the caching and execution subprocesses.
2017-Oct-23
Adds debug logging when an engine init error occurs during caching of toolkit actions.
2017-Oct-11
Bug fix for a sanity check when looking up a config root path.
2017-Oct-04
Security-related updates.
Details:
- When an unhandled exception bubbles up, we do not reply to the web app with the full exception stack. Instead, we reply with a general error message and log the full exception. If debug logging is turned on, we do reply with the full exception.
- String data has html tags escaped prior to replying over wss.
2017-Sep-25
Defaults to bootstrap for getting actions.
Details:
The "legacy workaround" is still in place, but is now behind a env variable wall (SHOTGUN_ENABLE_LEGACY_BROWSER_INTEGRATION_WORKAROUND). This commit also resolves an issue with Python 2.6 compatibility related to logging from the command execution subprocess.
2017-Sep-22
Bug fix for toolkit command execution from global entity pages.
2017-Sep-1
Deprecates the need for a self-signed certificate to establish a connection between the browser and the websocket server.
Details:
The server will now ask Shotgun for a copy of the private and public certificates to use to establish a connection between the browser and the desktop server. An extra layer of encryption is added between the two to avoid a man in the middle attack.
2017-Jul-21
Fix for lookup of Python interpreter paths for configs without interpreter cfg files.
2017-Jul-21
Fixes a regression that was introduced with the latest version of the Toolkit core with installed configurations.
2017-Jul-21
Fixes bugs related to which python.exe is used for caching and command execution subprocesses, as well as ensuring that PYTHONPATH is properly represented in sys.path within those same subprocesses.
2017-Jul-20
Adds a test suite. Small bug fix for immutable configs making use of shotgun_xxx.yml environments.
2017-Jul-17
More gracefully handles engine initialization problems during caching.
2017-Jun-23
Simplifies cache invalidation, which also brings with it some speed.
2017-Jun-21
Entity type whitelisting is cached in memory per configuration root.
Details:
This is required because you might have shotgun_playlist.yml (as an example) in one of a project’s configs, but not in the others. Prior to this change, the cached whitelist was keyed by project id.
2017-Jun-20
Performance enhancements.
Details:
Portions of the get_actions RPC method are now allowed to run in parallel. Additional in-memory caching of reusable data has been added. Switches to an md5 hashing strategy, as the Python builtin hash function did not behave consistently with the data we're giving it on Windows, which resulted in recaching of data that did not require it.
2017-Jun-19
Rolls back change made in v1.1.6 that resulted in boostrap errors when getting Toolkit menu actions.
2017-Jun-19
Speed enhancements for the v2 websocket server API.
2017-Jun-19
Fixes cache invalidation issues and properly replies to the client if an unhandled exception is raised when getting Toolkit menu actions.
2017-Jun-16
Fixes for edge-case bugs found during QA of v1.1.3.
2017-Jun-15
Addresses a number of regressions associated with the v2 API release.
Details:
This contains a raft of fixes for various issues raised by clients after the v1.0.0 release of Shotgun's Integrations related to browser integration with SGTK. This includes speed concerns when actions are requested from the server, issues with Task entities receiving a list of menu actions from their parent entity type (Asset or Shot, typically), and various edge cases that have shown themselves to have been improperly handled previously.
2017-Jun-07
Fixes a pair of issues with Chrome 59+ on macOS and 32-bit versions of the Shotgun Desktop on Windows.
Details:
Google has released a newer version of Chrome which breaks the browser integration on macOS. To fix the issue the certificates need to be regenerated. You can regenerate the certificates from within the Shotgun Desktop's user menu.
2017-Jun-06
Keys in-memory cache entries for pipeline configuration data by project id. This resolves issues with the My Tasks page, where Tasks are shown from potentially multiple projects.
2017-Jun-05
Implements a legacy workaround code path that allows classic-style configurations to make use of the v1 websockets API's approach to getting and executing engine commands via the v2 API.
2017-May-31
Bug fix for the case when a pipeline configuration does not exist on disk on the current host.
Details:
The result was a None returned from the pipeline configuration object, which was then passed to the os module, which did not handle it gracefully.
2017-May-31
Corrects an issue related to the TANK_CURRENT_PC environment variable and how it's set prior to engine command execution via websockets v2 web app integration.
Details:
When launching a DCC from the Shotgun web app, the v2 websockets integration would execute the engine command with the TANK_CURRENT_PC environment variable set to Shotgun Desktop's site configuration path. This caused issues after DCC launch due to the mismatch between that path in the environment, and the config path associated with the running engine.
2017-May-29
Adds support for descriptor-based pipeline configurations.
Details:
Note: This release breaks API compatibility with the previous versions of the framework.
This update brings a couple of new features to the browser integration. It also has been refactored so it can be used as an actual framework in a pipeline configuration and to launch the browser integration.
The browser integration is now much more efficient at generating and invalidating caches of actions that are accessible from the web-browser
Pipeline configurations using the new descriptor and plugin_ids fields are now supported by the browser integration.
This release fixes a certificate issue with Chrome 58+ on all platforms.
Please visit our support page to learn more about this issue and how to update your Shotgun Desktop installation.
Creates the certificate registry for a Linux user account that doesn't have one.
OSX 10.7 is now supported.
Better support for network paths in the file dialog.
Details:
For MacOS, we've added a link to the /Volumes folder in the dialog's sidebar so mounted shares can be accessed.
For all platforms, you can now edit the box at the top of the dialog to specify any path, including UNC paths on Windows.
Logger does not log the command line anymore on error and various usability fixes.
Fixed the DUPLICATE_SAME_ACCESS error when generating certificates on Windows.
Command-line based certificate generation and configuration file.
Details:
- Added a new python script under app/certificates.py that allows to generate the certificate on the command line.
- Added a configuration sample file at app/config.ini.example
- Both app.py and certificates.py can be run with --configuration that will point to a configuration file. NOTE: Certificate generation on Linux only works for Chrome. Firefox still needs the certificate to be imported manually.
Better error handling.
Details:
- Introduced a new exception type that can be thrown when the server is started, PortBusyError.
- All exceptions now derive from BrowserIntegrationError, which derives from Exception.
- Redirecting stderr's from certificate registration commands to stdout so everything is captured.
Fixed a bug where launching DCCs in Windows kept port 9000 alive even tough the Desktop had been closed.
- Details:
This issue was caused before file descriptors were inherited by child processes. Setting close_fds when launching an external processes prevents child processes to inherit the file descriptor for the port and to keep the port in use.
Fixed a bug where we weren't waiting for the reactor to completely stop when stopping the server.
Renamed folders to avoid reaching MAX_PATH characters in file paths on Windows.
Original release.