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-Apr-22
Bumps tk-core to v0.21.2
2024-Mar-26
Rebranding component for Flow Production Tracking
2024-Feb-22
Bumps tk-core to v0.20.34
2024-Feb-13
Bumps tk-core to v0.20.32
2023-Jan-30
Bumps tk-core to v0.20.31
2023-Nov-29
Bumps tk-core to v0.20.28.
2023-Nov-22
Bumps tk-core to v0.20.27.
2023-Sep-20
Bumps tk-core to v0.20.25 and introduces a check to prevent the startup logic from being upgraded to the latest available version in the event that SG Desktop is running on Python2.
This means that if you are using an older version, you will auto-upgrade and freeze to v2.1.24. No more auto-upgrades will be triggered.
2023-Sep-13
Bump tk-core to v0.20.24
2023-Aug-31
Bump tk-core to v0.20.23
2023-Aug-3
Bump tk-core to v0.20.22
2023-July-25
Bump tk-core to v0.20.21
2023-July-24
Bump tk-core to v0.20.20
2023-Jul-03
Prioritize User-Restricted Pipeline Configuration
2023-May-23
Bump tk-core to v0.20.19
2023-May-18
Bumps certifi from 2020.06.20 to 2022.12.7 Bumps tk-core to v0.20.18
2023-January-13 Remove 'SGTK_CONFIG_LOCK_VERSION'. Updates embedded core version to v0.20.16.
2023-January-10
Fix yaml.load backwards compatibility.
2023-January-6
Better error reporting for SG Desktop when Pipeline Configuration entity is disabled, also remove yaml.load warning.
2022-October-24
Moves to tk-core v0.20.14 fix unicode issues when login and working with files.
2022-Apr-12
This version resizes the splash.ui message box geometry to (20x260) 291x31 and replacing the message box background color to transparent in order to leave enough room for progress updates, also upgrades Black to v22.3.0.
2022-Mar-28
ShotGrid branding updates.
2022-March-10
Upgrades core to v0.20.11 to Improve the Autodesk identity login UX adding new environment variables TK_SHOTGRID_DEFAULT_LOGIN and TK_SHOTGRID_SSO_DOMAIN. Also fixes the issue that occurred when a git_branch descriptor is pointing to a commit different than the last one.
2021-December-1
Replacing shotgunsoftware urls with Autodesk Knowledge Network and ShotGrid Developer Documentation pages.
2021-November-23
Upgrades core to v0.20.7 to allow shallow git clones when using git descriptors.
2021-October-4
Moves to tk-core v0.20.6 updating unsecure version of httplib2.
2021-August-12
Moves to tk-core v0.20.4 to allow SG Desktop to use the login/password dialog instead of the Web login by setting the environment variable SGTK_FORCE_STANDARD_LOGIN_DIALOG.
2021-August-11
Setting the new environment variable SGTK_DESKTOP_SUPPORT_WEB_LOGIN_TRUE to any value will enable Web login for legacy login/password sites.
2021-July-26
Better error reporting when there is an authentication error.
2021-July-14
The ShotGrid API will now retry whenever the server returns a 502.
2021-June-4
Rebranded to ShotGrid.
2021-Jan-26
Removed support for the browser integration with tk-desktop v2.1.7 or older.
2020-Dec-8
Switches from using the support email alias to pointing to the support site. Upgrades core to v0.19.18
2020-Nov-19
Fixes an issue where Shotgun Desktop would not report that a version of an engine wasn't compatible with Shotgun Desktop 1.6.1 or later.
2020-Sep-21
Adds support for authentication via SSO when using Python 3 or PySide2.
2020-Sep-2
Fixes a crash when using a git-based descriptor for the tk-desktop engine.
2020-Jul-13
Adds Python 3 support and fixes an authentication issue
Details:
Fixes an issue with the Okta Sign In Widget 4.2.0 which prevented users from logging into Shotgun Desktop.
2020-Jun-22
Fixes an issue where users might be prompted several times for their credentials with certain SSO solutions.
2019-Sep-19
Moves to tk-core v0.18.168 to address NTLM related SSO issues on macOS and Linux.
2019-Jun-04
Moves to tk-core v0.18.167 to address Okta SSO issues.
2019-May-21
Fixes a regression where debug logging was forced on first launch.
Details:
This fixes a regression where "Toggle Debug Logging" is always checked, and debug logging is forced on first launch, even if TK_DEBUG is not set and no user preference exists. This occurred only when a core update was needed and desktop restarted to apply that update.
2019-Apr-08
Adds support for github_release descriptor.
2019-Feb-25
Update to the certificates distributed with the Python API.
2019-Jan-28
Adds support for the Shotgun Unified Login Flow.
2018-Nov-07
Git terminals will not be displayed on Windows when cloning repositories unless authentication is required on startup.
Details:
Note that this only applies to the startup of the Shotgun Desktop itself when displaying the splash screen. If you have taken over your site configuring or projects, make sure you've updated the core to v0.18.159 or you might still get some Git terminals.
2018-Oct-03
Fixes a bug that caused unnecessary disk operations when launching the Shotgun Desktop.
2018-Sep-25
Adds support for the Bootstrap hook when launching the desktop engine.
2018-May-25
Site urls are now lowercased during sanitization.
2018-Apr-17
Fixes some issues when running tk-config-default2 as a site-wide configuration.
2018-Mar-22
Zipped configurations will now pull their core from the zip file, if included.
2018-Mar-13
This fixes an issue with file name length when using uploaded configurations on Windows.
2018-Feb-15
Fixes an issue that prevents Shotgun Desktop from launching a site configuration using a core released between v0.16.0 and v0.18.0
2018-Feb-05
Login dialog now shows the most recent users and sites.
2018-Jan-15
Introduces support for single-sign on with Shotgun.
2017-Dec-14
Global debug logging is now restored prior to core swap.
Details:
This is resolving an issue that arises when the tk-core version in the site config is older than v0.18.117. In that case, when the global debug is toggled on in desktopstartup, TK_DEBUG is set in the environment. If it is toggled off after the core swap, that environment variable isn't purged since the older tk-core doesn't know to do that. We end up in a situation where TK_DEBUG persists, resulting in any subprocesses spawned running in debug logging active when it wasn't asked for.
Instead, we now restore the global debug setting prior to core swap, which ensures that the same version of tk-core is used both to set and restore global debug.
2017-Dec-12
Updates embedded core version to 0.18.120
2017-Nov-10
Bumps core version to v0.18.117
2017-Sep-25
Better URL filtering and cleanup on login screen.
2017-Sep-25
Better URL filtering and cleanup on login screen.
2017-Jul-26
Fixes an issue when reporting errors when Shotgun Desktop starts.
2017-Jul-24
Bundles v0.18.98 of tk-core, which makes the bootstrap process resilient to bundle download errors.
2017-Jul-19
Toolkit now detects cached configuration that weren't written completely on disk and fixes them.
2017-June-5
This fix prevents a crash when trying to update the Shotgun Desktop when the app store credentials are invalid.
2017-June-5
This fixes an issue where the incorrect path to the Shotgun Desktop's python interpreter would be written to the interpreter_*.yml files if it is not installed at the default location.
2017-May-31
This release introduces support for Shotgun Integrations.
Details:
Click here to learn more about Shotgun Integrations.
2017-May-08
Fixes AppStore connectivity issues when updating the Shotgun Desktop.
2017-Apr-26
This release fixes a certificate issue with Chrome 58+ on all platforms.
Details:
Please visit our support page to learn more about this issue and how to update your Shotgun Desktop installation.
2017-Apr-20
Fixes an issue on startup with CentOS if QT_PLUGIN_PATH is set.
2017-Feb-01
Toolkit App Store credentials issues are better handled.
2016-Oct-06
Fixes a crashing bug in Linux on startup when the ~/.pki/nssdb folder doesn't exist or that location has no database.
2016-Sep-14
Placeholder text is displayed when the text box is selected in the login dialog.
2016-Sep-09
Fixes an issue where unexpected errors during startup are not reported correctly to the user.
2016-Jul-29
Updates Shotgun Desktop to support the new toolkit.ini file.
Details:
Toolkit.ini is a new global file that can be read not only by the Shotgun Desktop but also by any Toolkit based applications. You can read more about this configuration file here.
2016-Apr-25
Fixes a crash introduced by trailing whitespaces in user login.
2016-Apr-18
Fixed error reporting when the Shotgun Desktop failed at configuring Toolkit.
2016-Apr-5
App Store specific proxy setting.
Details:
Following release v0.17.14 of core, this integrates App Store specific proxy setting for the Shotgun Desktop. It also adds a new setting called app_store_http_proxy to config.ini. This setting is used when creating the site configuration to instruct the new configuration how to connect to the App Store.
2016-Mar-30
handle Toolkit App Store connection timeout exception
Details:
Better handling for when the Shotgun API connection times out while connecting to the Toolkit App Store. For cases where internet access is blocked, this ensures that SG Desktop will abort the auto-update of the startup framework within a reasonable amount of time and continue loading without error.
2016-Mar-28
handle Toolkit App Store connection timeout exception
Details:
Better handling for when the Shotgun API connection times out while connecting to the Toolkit App Store.
2016-Feb-29
Upgrades to core v0.17.6 which adds case insensitive username comparison.
2016-Feb-25
Support @ in proxy authentication passwords.
2016-Jan-26
Browser integration now supports OSX 10.7.
2016-Jan-05
Startup does not log proxy settings anymore.
Details:
Due to security concerns, the framework is not logging out the proxy settings anymore during startup.
2015-Dec-16
An expired session on startup is now considered as not logged in.
Having TANK_PRESERVE_YAML set does not prevent the Desktop from upgrading anymore.
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.
Logging actions from the browser integration in a secure way.
Details:
The browser integration had a flag named debug which has been renamed to low_level_debug. The documentation for this flag has been updated to make it clear that Twisted might log sensitive information like passwords and such to disk. Therefore, it shouldn't be used in a production environment.
Command line parameters are no longer logged to disk when an application fails. This is done in order to avoid logging sensitive information.
Fixes an issue where hitting Command-Q on MacOSX on the login screen makes the app unresponsive.
Fixes a connection error and certificate generation issues.
Details:
- Better handling of errors when generating certificates.
- Better handling of errors when connecting to the app store to download the update to the Desktop Startup framework.
Change tray icon to fit in OSX Dark mode.
Enhanced tray-based workflow for people not using Toolkit and simpler configuration.
Details:
The Shotgun Desktop now always starts by running in the tray if there is no currently logged in user. Tray messages inform the user that the browser integration is running in the background and the user can sign in at anytime by clicking on the Shotgun icon.
The Shotgun Desktop's configuration file (config.ini) can now reside in the user folder at
Windows: %APPDATA%\Shotgun\desktop\config\config.ini
MacOSX: ~/Library/Caches/Shotgun/desktop/config/config.ini
Linux: .shotgun/desktop/config/config.ini
This avoids having to update the installation directory. You can also use an environment variable, SGTK_DESKTOP_CONFIG_LOCATION to point to a config.ini file anywhere on your computer or your network. The Shotgun Desktop will evaluate these in the following order:
- Look in the user directory.
- Look if the environment variable exists.
- Look if the file is present in the installation folder.
Fixes TK_SITE_CONFIG_ROOT behavior.
Adds support for TK_SITE_CONFIG_ROOT environment variable.
Cleaner error handling when connecting to tank.shotgunstudio.com during the tk-framework-desktopstartup update.
Fixes an issue on Windows where port 9000 might still be in use after closing the Shotgun Desktop.
Fixes an issue on Windows with paths that are too long in the roaming directory.
Fixes issues with the Shotgun Desktop and proxy servers.
Updated to launch commands from the websocket server in a cleaner environment.
Details:
This fixes the issue where applications like Maya or Nuke that were launched from Toolkit would report errors about the wrong path to the pipeline configuration being used.
Update the startup to continue even if there was an error during websocket startup.
Adds support for answering websocket queries from the Shotgun web interface.
Fixes an issue with old versions of the desktop engine and the newer Shotgun Desktop application (v1.1+).
Details:
The new Shotgun Desktop application (v1.1+) and the new login based authentication module are not supported by the old desktop engine. This new version of the startup logic validates that the right version of the engine is found.
This issue can only be encountered when the site configuration is locked to a pre-2.0.0 version of the tk-desktop engine and is not upgraded after installing the Shotgun Desktop application v1.1+. Users of the Shotgun Desktop who are running in auto-update mode will never encounter this issue.
Supports Shotgun Desktop migration away from the Template Project.
Details:
This release allows the Shotgun Desktop to update a site configuration so that it doesn't depend on the Template Project anymore. In order to migrate away from the Template Project, type tank migrate_desktop (introduced in core v0.16.8) to remove Shotgun Desktop dependency on the Template Project. Then, all users who launch the Shotgun Desktop will migrate their local site configuration automatically. If the site configuration was shared on the network, then the migration will already have been taken care of by the migrate_desktopcommand.
This releases adds Two-Factor authentication support.
Details:
Two-Factor authentication needs to be activated on your site first.
Removes dependency on the Template Project for the site configuration.
Details:
This release removes the need to have the Template Project to launch Shotgun Desktop. It is backwards compatible with existing site configurations. New site configurations will however be configured using a Pipeline Configuration not associated to a Shotgun project. Note: Due to the recent permissions changes on Shotgun, if you wish to keep using the Template Project configuration with artists users, you will need to assign them to the Template Project.
Better backward compatibility with script based authentication.
Details:
- The app now runs as a script user whenever possible.
- Bundles core v0.16.3
Initial release of the framework.
Details:
This framework allows to initialize the site configuration and launch the tk-desktop engine.