The driftool is a python application. To run it, it requires:
- python 3.12.0 (other versions might work but are not tested)
- pip
- git accessible via PATH
It is preferred to use the existing requirements.txt to create a virtualenv.
Please see the official virtualenv documentation.
💡 Note that for large repositories, the drift calculation can take some time. The number of comparisons is
(number of branches)^2 - (number of branches). Each comparison round is linearly dependent on the repository size. We experienced times around 1s per comparison.
💡 Driftool is not sufficiently tested on Windows. A known Windows issue is the possible inability to delete temporary files due to the git file lock. After using the driftool on Windows, please remove the ./tmp folder in the working directory manually.
For large (memory instensive) repositories, we recommend running the driftool from a RAM-Disk on a Linux system. This reduced the IO load significantly!
⚡Disclaimer: The driftool creates a temporary local copy of the git repository. It executes NO GIT PUSH commands. However, the tool is in active development and errors might happen. We recommend not to use the driftool on a not backed-up repository. (Disconnecting from the remote/network while executing the analysis is an equal measure).
- If installed, activate the venv and make sure all requirements are installed
- Run
python main.py config.yamlwith the desired configuration. - After completion, the drift metrics are printed to stdout, if specified, report files and graph views are generated.
All processing steps are performed on a temporary local copy of the git repository. The orignal repository is not touched.
To develop and test the docker setup you need an additional docker installation on your system.