Each Version of a Procedure is assigned a number at the end of its name. By default, we use a two digit numbering scheme. And, by default, each new version incremented by one. Version numbering is used to be able to identify minor vs major changes from one version to the next. This document explains how you can edit the version number to indicate minor and major changes. You can choose to jump multiple minor versions at a time to indicate significant updates to the procedure, but not enough to warrant incrementing the major version number.
Version numbers are generally assigned in increasing order and correspond to new developments in the procedure. At a fine-grained level, revision control is often used for keeping track of the incrementally between different versions of the procedure. The system was architected to facilitate sequence-based versioning schemes, with each release assigned a unique identifier that consists of two sequences of numbers.
This documentation provides details on:
How Version Numbering Works
The number for each version is used to convey the significance of changes between releases. Changes are classified by significance level, and the decision of which sequence to change between releases is based on the significance of the changes from the previous release, whereby the first sequence is changed for the most significant changes, and changes to sequences after the first represent changes of decreasing significance.
The best known numbering scheme for software is Semantic versions which uses a squired of three digits - Major.Minor.Patch. Breaking changes are indicated by increasing the major number (high risk), new non-breaking features increment the minor number (medium risk) and all other non-breaking changes increment the patch number (lowest risk).
Below is an example of a Procedure where the version was numbered incrementally by one from 1.0 to 1.1. Then a user set the name of the preceding version to be 1.5. The system then automatically started incrementing the version by one to 2.1 for the next version.
We use a two digit numbering scheme. By default, we automatically append a two digit version number at the end of the name. The version name includes its name and version number. The version number is prepended with “v”. The “v” prepended to the number is not required for our auto incrementality to work but is recommended.
Our auto incrementality for version numbering supports single digit scheme, two digit scheme or a three digit scheme. By default, we use a two digit numbering scheme.
- Single digit scheme -> 0
- Two digit scheme -> 0.0
- Three digit scheme -> 0.0.0
The version number must be at the end of the name and not be followed by any additional text.
To change from a two digit scheme to a three, edit the number in the name and include an additional digit.
Editing the Version Name and Number
The name of the version and its number can be changed. It is recommended to include at least a two digit number at the end of the name to allow auto incrementality to work.
To edit the name of a version, hover over the name of the version. Then click on the name or the edit icon.
The version name will then be switched into an editor that allows the name and the version number to be changed. The name and the version number can be changed. The “v” prepended to the number is not required for our auto incrementality to work but is recommended.
To save changes, click the save icon or anywhere else on the page.
Changing Version Number
The version number can be changed by editing the version name. In this example, the name of the version includes the number 1.2. To change the version number, hover over the version name and click on it.
Once the version name becomes editable, you can change the number in the name. In the example we are going to change the name from 1.3(which was automatically set by default) to 1.5.
To save the changes click on the save icon or anywhere else on the page. Since the number for the version was changed from 1.2 to 1.5, numbers 1.2, 1.3 and 1.4 were skipped. When the next version is created, the name would include number 1.6.
To indicate a major change from one version to the next, the major digit in the number can be changed. In the example below, the number is changed from 1.7 to 2.0.
Once the value is saved, the numbers between 1.7 and 2.0 are skipped.
By default, the next version would then be 2.1. This version number could also be changed.