GitLab

Functionality to add

In the development process of a library, one will encounter plenty of bugs. In that case it is extremely useful to know which version of the library was used to produce some results.

An option to achieve this would be to store the custom library commit hash and name in the log file

e.g.

/*---------------------------------------------------------------------------*\
| =========                 |                                                 |
| \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox           |
|  \\    /   O peration     | Version:  com                                   |
|   \\  /    A nd           | Website:  www.openfoam.com                      |
|    \\/     M anipulation  |                                                 |
\*---------------------------------------------------------------------------*/
Build  : 00425fe658-20200403 OPENFOAM=2002 patch=200316
Custom Build : <commit hash>-date libraryName=<name of the library> // proposed
Arch   : "LSB;label=32;scalar=64"
Exec   : interIsoFoam -parallel

Target audience

Proposal

Print the custom commit in the log file of the application

What does success look like, and how can we measure that?

Links / references

Funding