Use "git describe" to display a nice rev-number

[Ghabry]

After creating our first tag (0.1) "git describe" can be used to get a more readable revision number 0.1-### (where ### is the number of commits since 0.1).

The output of "git describe" should be written in some header file and then be included by player and e.g. displayed in the title bar.

This makes it easier for us to figure out which version somebody uses (Maybe also write it in the PNG-tEXT chunk under "Software" if he used our screenshot function and we cant see the title bar). And to detect if somebody made local changes (e.g. by adding an 'M' after the rev number)

[Ghabry]

$ git describe
0.1-50-g56690ab

$ git describe | cut -d - -f -2
0.1-50

50 is the number of commits since tag 0.1

What do you think about adding some pre-compile step that writes this in a file for include?

[fdelapena]

Well, hash tail is ugly but descriptive (makes easier to find the right tree here), but I have no preference though.

[Ghabry]

Ghabry@b11acb0

Feedback welcome (and updates to cmake + automake to invoke revision.sh)

[Ghabry]

"Looks legit, however in my opinion tagged (official) source packages, e.g. easyrpg-player-0.1-src.tar.gz should include pregenerated revision.h by default and not depend on git usage."

Ghabry@c212b17

Simple heuristic: Don't write file when .git is missing and revision.h exists.

[Ghabry]

@Lobomon
The build job sets now versionCode and versionName to proper values via some sed-magic:

versionName = git describe | cut -d - -f -2 | sed s/-/./g
versionCode = git rev-list HEAD --count

(this should become a part of the android build script later)

[fdelapena]

For non-win32 ports, configure.ac and CMakeLists.txt has a builtin version number macro, doing a sed replacing for these on Jenkins jobs will generate a version define (autotools adds these defines to config.h). These can be patched before calling ./configure or cmake.

configure.ac and CMakeLists.txt standard define name for versioning is PACKAGE_VERSION
It can be assigned to the PLAYER_VERSION define or simply use it directly.

[Ghabry]

Considering we are full CMake and Autotools now it should be finally possible to add this without toooo much afford?

See also #2070