Version control of projects¶
DSS comes builtin with Git-based version control. Each change that you make in the DSS UI (modify the settings of a dataset, edit a recipe, modify a dashboard, …) is automatically recorded in the version control system.
This gives you:
- Traceability into all actions performed in DSS
- The ability to understand the history of each object
- The ability to revert changes
You don’t need to configure anything to benefit from version control. However, by switching to explicit commit modes, you can get more control.
On the project homepage, click on “Changes”. The project’s history browser appears. You can view all commits made on the project. Scroll to the bottom to load more commits.
You can click on any commit to view the details and browse the changed files on this commit. By clicking on the “Compare” button, you can compare the state of the whole project between two revisions.
In addition, when you are in an object (dataset, recipe or web app), you can click on the History tab to view the history of only this specific object.
On the project’s change page, you can revert your project to a specific revision.
Reverting a project to an older revision will discard all work performed in all aspects of the project since that revision, by all users of a project.
Reverting only affects the configuration of the project (datasets, recipes, web apps, dashboards…). It does not affect data. Thus, after revert, some data might be missing and might need to be rebuilt
Reverting does not affect Jupyter notebooks at that time. It is not possible to revert to older versions of Jupyter notebooks.
Click on the revision you want to revert to, and click on “Revert to this revision”.
From an object’s history tab, you can revert only this object (recipes only for now) to a specific revision. Other objects in the project are not affected.
Reverting a single object is a dangerous operation, since it might make the reverted object inconsistent with the rest of the project. Various issues may appear.
Reverting a single object may cause Git conflicts. In that case, DSS will not perform the revert. You will need to perform it manually using the Git command line.
We advise that you only use this option to revert to previous revisions only in presence of “simple” changes like changes in code rather than “structural” changes (changing inputs of a recipe, …)
On the project’s change page, you can revert a single previous commit. A “reverse” commit will be added to the history of the project.
Reverting a single revision is a dangerous operation, since it might make the reverted object inconsistent with the rest of the project. Various issues may appear.
Reverting a single revision may cause Git conflicts. In that case, DSS will not perform the revert. You will need to perform it manually using the Git command line.
We advise that you only use this option to cancel previous commits that only contain “simple” changes like changes in code rather than “structural” changes (changing inputs of a recipe, …)
Tier 2 support: Support for pushing to Git remotes is covered by Tier 2 support
The version control in DSS is a regular Git repository (which can be managed with the
git command line tool).
It is possible to connect the repository of each project to a Git remote, for pushing the work done in DSS to any Git server or Git hosting service.
To manage remotes connected to the Git repository of a given project in DSS, go to the Changes page for this project and click on Manage remotes.
For more details on working with Git remotes, see Working with Git
Managing remotes for projects is not available if your DSS is configured for a single global Git repository. This is only the case if you have an extremely old DSS instance (see below)
Version control of projects in DSS does not permit branching nor merging.
We strongly advise against pushing from several different instances to the same Git remote.
When you install DSS, it is by default configured to have one Git repository per project, plus a global Git repository for “global” configuration elements (Administration settings, connections, users and groups, …)
DSS can also be configured to have a single Git repository for the whole configuration of all projects.
We don’t advise changing this setting. Using global repository makes it impossible to manage Git remotes.
To change this setting:
- Stop DSS
install.ini, and in the
mode = global
- Start DSS