search

cms-analysis / HiggsAnalysis-CombinedLimit

CMS Higgs Combination toolkit.
https://cms-analysis.github.io/HiggsAnalysis-CombinedLimit/latest
Apache License 2.0
75 stars 381 forks source link

Version missing #880

Open adavidzh opened 9 months ago

adavidzh commented 9 months ago

I just tried the docker image (because CAT-23-001) and I was surprised positively that there is now a cute heading when running the tool:

[cmsusr@a1bfab4ca9ff code]$ combine
 <<< Combine >>>
Missing datacard file
Usage: combine [options]
Use combine --help to get a list of all the allowed methods and options

OTOH, taking the perspective of a software user, it is kind of weird that there is no version information, neither in the header, nor as a command line option:

[cmsusr@a1bfab4ca9ff code]$ combine --help | grep ersion
[cmsusr@a1bfab4ca9ff code]$

I think this can be a real pain to deal with support requests.

Should the version be compiled into the code in order to embed it into printouts and perhaps even ROOT file outputs ("This result brought to you by combine vX.Y.Z")?

nucleosynthesis commented 9 months ago

Fixed with https://github.com/cms-analysis/HiggsAnalysis-CombinedLimit/commit/ce02748834e771595f073f7d906f805a81ee9e1f

kcormi commented 9 months ago

One thing which might be a good idea is somehow automatically syncing between the version the code prints out and the tags, so that we don't rely on always remembering to do both.

I think it could be done with the highest answer as giving here: https://stackoverflow.com/questions/33481173/is-there-a-way-to-make-git-auto-generate-a-version-number-file-for-a-version-o