hiker
commented
1 day ago I've found https://stackoverflow.com/questions/3442874/in-git-how-can-i-write-the-current-commit-hash-to-a-file-in-the-same-commit. In short, we can't add the hash before writing the file (since adding the hash will change the hash). One solution mentioned was to use the previous hash. Or we could use the post-checkout hook? Not sure how this works with updates, merge, cherry-pick etc. git attributes are mentioned, but they apparently need to be installed each time manually(?)
On https://softwareengineering.stackexchange.com/questions/333680/how-to-version-when-using-trunk-based-development it was mentioned:
To differentiate "trunk-builds" from official releases, it is common to add a suffix like
snapshot-DATETIMEto the version number.
Not sure if this can be automated (i.e. modified automatically on commit) - I did a brief search, and there seems to be odd cases where modifying file might have unexpected side effects. I hope one of you knows more of git hooks than I do :)
I am getting the feeling that just adding "-alpha" to the version number after a release might be the easiest option (and would work for me, all I need is to distinguish current master from the last release). It would also follow the semantic versioning standard (https://semver.org/).
One other idea: version.py tries to run and interpret git branch (we can't use git branch --show-current, it provides no output in case of a tag or hash based checkout). Possible outcomes (not sure if this list is really complete)
(HEAD detached at 2.5.0)--> checked out tags/2.5.0 - identified by a regular expression of integers and dots(HEAD detached at 2f4162581)--> checked out a hash - identified by not a version number as above, and a valid hex number- Any other non-error: we are on a branch - use the existing version number and append
-with branch-name (2.5.0-257_verify_loop_fusion) - Error - not a git checkout, just use the existing version number.
arporter
At the telco today, we agreed that the PSyclone version number (stored in
src/psyclone/version.pyand also indoc/reference_guide/doxygen.config) should have the git hash of the last commit (to master) appended to it. This will enable people to see when they are working with a version checked-out of GitHub, as opposed to a released version.We could do this manually as part of the end-of-the-review process but it would be much better if we could automate it using a GitHub Action.