Manual update

When you update items in a workspace or undo a commit, there’s always a chance that one or more items will fail. The workspace fails to update if the incoming update from the Git branch causes inconsistencies or other problems in the workspace that are difficult to determine in advance. When an item fails to update, the update process stops. If the item that failed is the first (or only) item that was updating, the workspace remains synced with the original branch. If an item fails after one or more items succeeded in updating, you have a situation where some items are synced and some aren't. In this case, your workspace isn't synced to any Git branch.

Important

This feature is in preview.

An update can fail for many reasons. Possible reasons include, but not limited to, the following problems:

  • Dependent items were changed or deleted
  • Circular dependencies were created
  • Item renamed
  • Invalid item data

Note

This is not the same as conflict resolution. If changes were made to the same item in both the workspace and Git branch, it causes a conflict and updates are disabled. This article discusses what to do a workspace fails to update even though there are no direct conflicts.

An error message lets you know which item failed and why.

Screenshot showing the error message when update fails.

This error message appears when the update fails. Any user trying to access the workspace after that sees the following error until the update is completed successfully.

Screenshot showing the error message when someone tries to connect to a workspace after an update fails.

Select View details to see the previous error message.

Git statuses after an item fails

Your workspace now contains the following items:

  • The item or items updated before the failure. These items are identical to the items in git, but the metadata isn't updated. They have a Git status of synced but with a triangle warning sign.
  • The item that failed. This item has a Git status of Update required.
  • Possibly, items that weren't updated yet when the item failed. These items haven't been updated yet and have a Git status of Update required.

The status bar at the bottom of the screen that shows the latest sync status is red and indicated the partially synced status.

Screenshot showing status line at the bottom of the screen when an update fails.

Update the failed item

To update the workspace manually after it failed to update automatically:

  1. Figure out which item is causing the update to fail and what the problem is using the error dialog that says which item failed and error message.
  2. Fix the problem in Git. This can mean doing one or more of the following depending on what the issue is:
    • Revert the item to an earlier version that doesn't fail
    • Edit the item resolve the problem
    • Restore a dependant item that was deleted
    • Delete unsupported item that depends on the deleted item
  3. Go back to the workspace and Update the entire workspace again.

Considerations and limitations

The update process fails as soon as one item fails. Therefore, there's no way to know if other items in the Git branch are also problematic. If you're updating many items and more than one item is problematic, you have to repeat this process once for each failed item.

Conflict resolution