Official Collaborate Release Notes and Known Issues

Hello! This thread will be kept up to date with release notes for the Collaborate back end service, Collaborate package and changes to the Collaborate section of the Developer Dashboard. It will also have an updated list of known issues.

Release Notes

February 4, 2020

We've released the Collaborate v1.3.7 package, compatible with 2020.1.0a22 (and above)

• Bulk revert is now supported.
• Collab is blocked in play mode.
• Fixed services window's links to open Collab.

December 17, 2019

We've released the Collaborate v1.3.4 package, compatible with 2020.1.0a13 (and above)

• Window state is no longer restored after the window is closed and opened.
  
• Fixed History tab failing to load on startup if it is left open in the previous session.
• Fixed progress bar percentage not matching the bar.
• Fixed History list correctly updates after a new revision is published.
• Fixed UI instabilities when restoring or going back to a revision with a different package manifest.
• Improved handling of changes to the project id.

December 6, 2019

We've released the Collaborate v1.3.2 package (the updated version of v1.2.17), which is compatible with 2020.1.0a13 (and above)

• Update UX to UIElements.
• Increased minimum supported version to 2020.1.
• Update Documentation to required standards.

November 25, 2019

We've released the Collaborate v1.2.17 package, which is compatible with 2020.1.0a13 (and above)

• Update UX to UIElements.
• Increased minimum supported version to 2020.1.

May 28, 2019

We’ve released the Collaborate v2.0.0-preview-17 package, which is compatible with 2018.3.10f1 (and above).

• [COL-786] Collab Ignore Rules Only Accepted on Untracked Assets
• [COL-520] Fix History Window styling under the refreshed editor theme in 2019.3.

May 28, 2019

The following is a list of bug fixes that are included in Unity version 2018.4.1.f1+ and 2019.1.2f1+.

• [COL-324] For some projects, Collab is turning itself off without user confirmation. Users are returning to their projects and finding that Collab is in the Start Now state. Refreshing the Services Window shows that Collab is no longer enabled. No package version requirements.
• [COL-347] For Collaborate v2.0.0-preview-8: If Unity loses network connection or Collaborate is turned off and on in the Services window, Collaborate may display an undismissable dialog on reconnection. It is not blocking and will go away after restarting Unity.

May 21, 2019

The Collaborate v2.0.0-preview-15 package is now available, which is compatible with 2018.3.10f1 (and above). You can read more about this update and the future of Collaborate on the “Choosing between Collaborate’s 1.2.16 and 2.0-Preview-15 Packages“ forum post and “The First Steps to a New Collaborate“ blog post.

Note: To mitigate performance issues that resulted from removing the checking for changes dialog, we have introduced a manual rescan button as the only mechanism for pulling in newly modified files. This means that while using this version, Collaborate will not automatically scan and display files as you change them.

• [COL-395] Collaborate now only supports manually triggering a scan of your project files. This can be done via a “scan” located on the bottom right of the publish window
• [COL-346] The Collaborate log file now rotates to avoid the file growing overly large.
• [COL-353] Projects with a large number of files will no longer consume large amounts of CPU while idle.
• [COL-398] Scanning no longer consumes large amounts of CPU resources.
• [COL-429] Collaborate no longer gets caught scanning forever in the case of a failed migration of .collabignore.
• [COL-442] Collaborate no longer get stuck in “Operation not defined” error loop.
• Logging across the package has been enhanced to help find and solve issues faster in the future.

April 10, 2019

We’ve released the Collaborate v2.0.0-preview-8 package, which is compatible with 2018.3.10f1 (and above) and 2019.1b4 (and above). This update focuses on improving the performance of the package compared to v2.0.0-preview-6. Changes are:

• [COL-353] Collaborate now uses less ~30% less CPU while idle. More fixes are in the pipeline for further improvements.
• [COL-398] Collaborate now uses less ~30% less peak CPU when enumerating changes. More fixes are in the pipeline for further improvements.

March 27, 2019

We’ve released the Collaborate v2.0.0-preview-6 package, which is compatible with 2018.3.10f1 (and above) and 2019.1b4 (and above). Changes are:

• [SST-3990] Collaborate will no longer trigger the “Hold On: Checking for Changes” blocking dialog. This process will happen in the background, making start-up times significantly improved for large projects.
• [SST-3942] The state of changes in the project are now completely tracked via Git mechanisms instead of the previous file-based snapshot. The file based snapshot had the possibility of becoming corrupted, causing data-loss or files getting out-of-sync with the server. As a result of this, the .collabignore file in every project now has more importance. If you have files that are being incorrectly included, you may need to adjust the contents of the .collabignore file. The syntax is the same as standard gitignore file.
• [COL-28] Many internal processes have been optimized by making them execute asynchronously, preventing the UI from blocking in some cases.

March 22, 2019

• [SST-3736] Collaborate now has region support for source files! The location is determined at the time of first publish and is based on proximity to North America (Iowa), Europe (Belgium), or Asia (Taiwan). Data from other Unity services may be in other regions.
• [DD-560] Added a new section in the “Storage” page on the Developer Dashboard to show the hosting region for a project's source files stored in the Collaborate service.

March 13, 2019

• [COL-298] Fixed an issue that was causing the “File History” section on the Developer Dashboard to show incorrect information.

March 11, 2019

• [COL-243] Fixed an issue that was causing the history of a file to take long to load on the Developer Dashboard.
• [COL-130] Added the total size of a project to the export zip JSON payload. This will be exposed via the Developer Dashboard at a later date.
  [COL-244] Editor background requests to "check for latest changes" use less bandwidth unless recent publishes were made.

March 6, 2019

• [COL-135] General improvements to full project export which should decrease the time it takes overall
• [COL-274] Reduced the time it takes for the Unity Hub to populate the list of cloud projects.

Known Issues

• [COL-13] Client displays a "Cannot submit change to server" error when two people publish to Collab at the same time. To work around this, the creator whose content did not publish will need to update and then publish again.
• [COL-16] WinMerge is not supported when clicking “See Differences” on a file within the Unity Editor.
• [COL-24] Unity Editor will crash if Unity is closed before a Publish finishes.
• [COL-28] Collaborate updates take longer than expected on projects larger than 25GB.
• [COL-30] Collaborate does not support p4Merge as merge tool.
• [COL-32] Collaborate can cause congestion on networks with low upload speeds.
• [COL-287] When downloading a project from In The Cloud on the Hub, Collaborate does not download folders unless there is at least 1 file/folder in them.

Collab Package v1.3.2 (formerly v1.2.17)

• [COL-1079] The history window doesn’t correctly distinguish local vs remote changes
  [COL-573] Publishing new versions of some packages in Collab results in Cannot Copy File error
• [COL-1083] Error message for opening diff tool on conflicted file when none are installed is not very helpful. Workaround is to install and select a supported diff tool in the Preferences->External Tools window.
• [COL-1084] Triggering a domain reload while Collab History tab is open disables the UX until the Editor is focused. Workaround is to click onto the Editor a second time.
• [COL-1085] Go Back To commit in 2020.1 with pre-v1.2.17 in package manifest breaks Collaborate window. Workaround is to open project in a version of Unity older than 2020.1.0a13 where pre-v1.2.17 packages are supported.
• [COL 1109] Changing the UPID may need the window to be closed and opened. Otherwise, will see GitRepoService::MissingOIDError and ExternalAPI::Failure errors until the Editor is restarted.
• [COL 1110] Turning off collab does not immediately update the UI. Either switch page in the service window, or reopen the collab window to fix.
• [COL 1111] When creating a new project, enabling Collab, creating a new scene, then going back to the first revision makes the window unstable (double updating, double button presses, etc). Reopening the window fixes this. In the upcoming version, this will cause an exception instead due to our better invalid state checking.
• [COL-1115] Collab does not react to offline or online status correctly.
• [COL-1116] Collab usable in play mode when it shouldn't be.

Collab Package v2.0.0

• [COL-344] Reverting files in the Collab publish UI will sometimes display a blank message and will not work. To work around this, right click on the file and go to Collaborate > Revert.
• [COL-348] The Collab Toolbar drop down can sometimes appear stalled during publish. Entering and exiting play mode will help resolve this.
• [COL-364] Icons will disappear on the Collab UI window when using the partial partial publish feature. This will resolve automatically when a new change is detected.
• [COL-463] Going into play mode while scanning appears to stop the scan; however, it is still occuring. The UI will update once it has finished.
• [COL-484] Deleting a file between clicking scan and publish can infrequently cause an exception.
  
• [COL-500] The Collaborate window UI can stall during large updates. This typically occurs if you change applications or switch virtual desktops while updating. If the issue persists for more than 10 minutes, restart the Editor and try again.The update process will pick up where it left off.

 

Added new release notes for the Collaborate v2.0.0-preview-17 package.

 

Added new release notes and known issues for Collaborate v1.3.2 package.

 

Added new release notes for Collaborate v1.3.7 package.

 

Known Issue for v1.3 and v2.1:

When using Collaborate to "Go Back To" a revision that uses a pre-2020.1 Unity Editor, this may downgrade the Collaborate package to an earlier release that doesn't work with 2020.1. When this happens, please navigate to the Package Manager UI (Windows->Package Manager) and upgrade the Collaborate package back to the most recent 1.3.x (or 2.1.x-preview) release.