Reviewing and managing the candidate version settings
| 🌐 This document is available in both English and Ukrainian. Use the language toggle in the top right corner to switch between versions. |
1. General description
By creating a new candidate version for making changes to the registry regulations, you can review its status and settings.
You can find the new candidate version in the top left corner of the page by expanding the dropdown menu for managing the regulations version.
When creating a version, the regulation administrator can view the date and time of creation, as well as the description of the change.
- The registry regulations administrator can also:
2. Conflicting changes relative to the master version
A merge conflict is an event that occurs when the system (Git) cannot automatically resolve differences in code between two versions of changes.
Suppose there are two persons working on changes to the regulations: user A and user B. Both are working on the same code file from the repository and trying to make different changes to this file within their candidate versions (e.g., simply changing the name of a business process). After making changes, user A applies the changes to the master version. Now, when user B tries to apply their changes to the same file within their candidate version, they cannot do so because the file has already been modified by user A, and the changes are merged into the master branch.
| In such a case, user B cannot get updates from the master version due to the conflict. The way to resolve the conflict is to withdraw the change request, i.e., cancel candidate version-02 and create a new change request. |
3. Reviewing the list of changes
In the Administrative portal, you can easily review the list of changes made.
To review the changes made to the candidate version, follow these steps:
-
Go to the respective candidate version in the top left corner of the page by expanding the dropdown menu for managing regulation versions.
-
Navigate to the Proposed changes section.
-
Expand the change category. For example, Business process models.
-
Review the files that have been changed.
4. Getting updates and updating the status of open change requests
| To continuously synchronize the master version with all candidate versions and update the status of open requests according to the latest master version, the system automatically updates all open change requests (candidate versions). |
The registry regulations administrator can also manually update their candidate version from time to time. This can be done as follows:
-
Go to the respective candidate version in the top left corner of the page by expanding the dropdown menu for managing regulations versions.
-
Click the
Updatebutton.
5. Applying changes to the master version
After completing the work within the candidate version, it is necessary to apply the changes made to the master version so that other administrators can see the current state of the registry regulations repository. To do this, follow these steps:
-
Go to the corresponding candidate version in the top left corner of the page by expanding the drop-down menu for version control.
Before applying changes to the master version, you need to get updates first. -
Click the Apply changes to master version button.
-
In the warning window, confirm the changes to the master version or close it.
You will receive a confirmation window for the following action:
Please note that the deployment and verification process is not yet complete or has encountered errors. Applying changes may result in errors in the master version of the regulations.
The deployment and verification process is the
MASTER-Code-review-registry-regulationspipeline in Jenkins. It precedes the process of code compilation and publishing changes to theMASTER-Build-registry-regulationsregulations. Currently, the registry regulations administrator can manually bypass the Code review process by directly applying changes to the master branch of the repository.
As a result, the changes will be included in the master branch, and the selected candidate version will be automatically removed from the list of versions.
6. Withdrawing a change request within the candidate version
If necessary to withdraw a change request within your own candidate version, for example, due to merge conflicts, follow these steps:
-
Go to the corresponding candidate version in the top left corner of the page by expanding the drop-down menu for the regulations version control.
-
Click the Withdraw button.
As a result, the changes will be canceled, and the selected candidate version will be automatically removed from the list of versions.