Version Control model for collaborative development

Exclusive editing using Lock / Unlock

When several persons edit a file simultaneously, depending on the timing at which the submissions to the repository are done, there is a risk of overwriting files just edited by other people.
In order to avoid such conflicts, CRI Atom Craft recommends a version control model using "lock" / "unlock".
By using this function, only one person is in charge of a file at a time and can edit it safely.

Below is an example that shows the workflow when Person A and Person D want to edit the same Work Unit A.

craftv2_vcs_model_lock1.png


1. [Person A] Locks the work unit and starts editing

Person A edits Work Unit A as follows.

  • (1) Gets the latest version of Work Unit A from the repository.
  • (2) Locks Work Unit A
  • (3) Starts editing

    craftv2_vcs_model_lock2.png

2. [Person A] Ends editing and unlocks

When the work is done, Person A ends the editing of Work Unit A as follows.

  • (1) Registers the editing result in the repository.
  • (2) Unlocks Work Unit A

    craftv2_vcs_model_lock4.png

3. [Person D] Locks the work unit and starts editing

Since the Person A has finished editing, the next person-in-charge, Person D, starts editing Work Unit A.

  • (1) Gets the latest version of Work Unit A edited by Person A from the repository.
  • (2) Locks Work Unit A
  • (3) Starts editing

    craftv2_vcs_model_lock5.png
    [Person A]Finished editing; [Person D]Start to edit

Note
If Person A is still editing but Person D tries to lock Work Unit A, an error occurs.
In other words, Person D cannot edit and has to wait.


craftv2_vcs_model_lock_image.png
[Person A]Editing; [Person D]Waiting to edit


4. [Person D] Ends editing and unlock

When the work is done, Person D ends the editing of Work Unit A as follows.

  • (1) Registers the editing result in the repository.
  • (2) Unlocks Work Unit A

    craftv2_vcs_model_lock6.png

Following the above workflow to ensure the edition between Person A and Person D will be done without mistakes.

Note
CRI Atom Craft has a function for conflict resolution, and it is processed on a pre-file basis.

Combined use with client tools

By introducing the version control plugin to CRI Atom Craft, version control commands can be executed from CRI Atom Craft, but it can also be used in conjunction to the version control system client tool (TortoiseSVN in Subversion).

Performing version control with CRI Atom Craft

First of all, using the version control system client tool, add the project into the repository.
Now it is possible to update and add files using CRI Atom Craft.

craftv2_vcs_colabo_craft.png


Note
In order to perform version control with CRI Atom Craft, it is necessary to put the project folder under version control.

Use your own version control system

Version control of the files can be done with the client's own version control system.
Please use the client's own version control system if the commands can only be executed from that tool and have no equivalence in CRI Atom Craft, or when designers prefer to focus on audio authoring but not using version control plug-in in CRI Atom Craft.

craftv2_vcs_colabo_vcs.png