About Version Control
Workbench version control allows you to create versions of project files and later, if needed, restore files to an earlier version. This is a best practice when collaborating on large projects where multiple people might work on the same files. The ability to revert a project script to a previous revision can help track edits and correct mistakes.
NOTE: Each developer should visit Tools > Preferences > Version Control to set the name and email for commits from their Workbench.
Starting with version 7.1(14) you can also use push, pull, and clone commands to implement DTAP-style software release management. Workbench uses Git under the covers. See Managing Software Releases.
When an initial commit is made, a repository of selected files is created within the project structure on the server. This repository is not visible within Workbench Explorer. Do not make changes directly within the file system folder as that might cause unpredictable results. You should always use the Version Control dialog boxes in Workbench to change settings or manage any file revision issues.
Certain file types and directories are ignored by default.
The automatic default patterns ensure that you do not include large or temporary files. See Default Folder Structure for information about the directory structure and which directories do and do not default to use version control. The additional ignore patterns are set when you choose to use the automated version control feature. For more information, see Automating Version Control.
You can edit or add to this list of ignored file types. See Managing Ignore Patterns for information about changing the ignore patterns.
You can access the version control commands as follows:
- Tools > Version Control—Permits actions at the project level
- Right-click > Version Control—Permits actions at the file, folder, or project level
- Tools > Project Settings > Version Control—For an open project, permits adjustments to version control automation
TIP: You cannot include files from either project or system aliases in Workbench version control. For files from a project alias, use version control in the project where the file exists.