0

Working with Version Control: Check Out and Check In

In version control, the system identifies projects that are available for checkout with the modified blue folder icon, as with Project A in screenshot below.

To check out a project, click the project in the projects folder and click Check Out Revision. The system verifies your access rights and confirms the project is now checked out with an on-screen message.

  • If a later version is available, the system will ask if you want to first update to the latest revision and then check out
  • If you do not have the appropriate permission (remote-modify workspace role), the system will notify you and not check out the project to you
  • If there is an error, see this article for troubleshooting help

Restricted Revisions (Release 8.3+)

  • Only Admin Designer Users can check out a revision marked as Restricted .
  • Non-admin Designer users can only check out the latest unrestricted revision

Once you have checked out a project you are free to make any changes to project details, including the folder location of the project,  logicnets, and resources as required. During this time the project remains checked out under your username, even if you log out of the system.

  • If shared workspaces are not in use:
    Other users with access to the project are able to modify the project as normal (group version control)
  • If shared workspace(s) are in use
    When another user tries to check out the project, the system displays a message saying the project is already checked out to another user.
    Other users are able to view and test the project in its prior state. None of the changes you made are visible to others until you check them in.

When you have finished making changes, you can check in the changes or discard them by choosing one of the following options:

  • Discard Revision - No changes are saved. The system discards the project changelog and it cannot be retrieved at a later point.
  • Check In Revision - Choosing this option opens a popup where you can add a status and revision notes.
    Draft, Beta, Released, Discontinued (Release 8.3+) are available to all users
    Restricted status is only available to Designer Users with admin rights for the workspace (Release 8.3+)

    Once you have checked in or discarded the changes, the project is available for other authorized users to check out.

 

Version Control and the Changelog table

The changelog table stores a list of click-by-click edits made to the project, including any steps undone and/or redone. See this article for more information about this feature.

 

Release 8.3 contains an additional changelog entry when a project is checked out. The position of this entry and the prior checkout entry in the changelog table allows you to quickly identify the changes made between revisions. If there have been many edits, consider downloading the table to XL to view in more detail.

In the event a project is reverted to an earlier version, the changelog entries associated with later versions is not displayed unless and until the project is migrated back to the latest version.

Also, if the project is unlinked from version control (feature reserved for users with the workspace admin role), an additional changelog entry of "Project Unlinked" is created at that point.

 

For installations prior to Release 8.3, see below for identifying changelog entries between versions.

Using the Revisions tab and the Changelog table you can identify all the edits made since a given revision:

  1. identify the revision date from the Revisions table
  2. in the Changelog table, enter the following >YYYY-MM-DD hh:mm:ss, <YYYY-MM-DD hh:mm:ss and then [revision date +1 day] to search for all edits made since that date
    (currently search is limited to date only)
  3. see the entries in the Changelog table to inspect any/all edit steps

In future Releases we anticipate offering more sophisticated search and download capabilities to help isolate specific changes by version-controlled revision.

Impact of Check In

  • Changes made to a checked out version that is then discarded are also discarded.
  • Changes made to a checked out version that is then checked in are kepy

To illustrate this feature see the following example changes and impact.

Make edit:                 Change 1             => Change control shows Change 1
Make edit:                 Change 2             => Change control shows Change 1 + 2
Add to revision control:   Rev1                 => Change control shows Change 1 + 2
Check-out =>               Change control shows Change 1 + 2
Make edit:                 Change 3 )           => Change control shows Change 1 + 2 + 3
Check-in:                  Rev2 (based on Rev1) => Change control shows Change 1 + 2 + 3
Revert:                    Revert to Rev1       => Change control shows Change 1 + 2
Check-out =>               Change control shows Change 1 + 2
Make edit:                 Change 4             => Change control shows Change 1 + 2 + 4
Check-in:                  Rev3 (based on Rev1) => Change control shows Change 1 + 2 + 4
Revert:                    Revert to Rev2       => Change control shows Change 1 + 2 + 3

Reply

null

Content aside

  • 1 yr agoLast active
  • 41Views
  • 3 Following