Add git info to title screen & gameplay stats

[Pepe20129]

The branch shows up if it the current commit doesn't have a tag (see here).
In the title screen, the commit hash will appear if the oot debug mode is enabled; in the gameplay stats, it'll appear if Show Debug Info is enabled.

Build Artifacts

• soh.otr.zip
• soh-linux.zip
• soh-mac.zip
• soh-windows.zip

[Archez]

I think rather than checking if the branch starts with develop we should instead check if the current commit has a tag ref, if it doesn't then it's essentially a non-release build.

This would make it so that even nightly builds or builds from the develop-rando branch would display the git details too. Especially since develop still shows the version as the "latest" named release.

[Pepe20129]

I don't think that'd work as the builds get made before the commit is tagged.

[Archez]

I believe tagging in github causes another round of builds, which are the ones that get used for releases

There are two actions runs, one for the merge commit, and one for the tag

[Pepe20129]

I think rather than checking if the branch starts with develop we should instead check if the current commit has a tag ref, if it doesn't then it's essentially a non-release build.

Changed it.

[briaguya-ai]

i've been hoping to be able to remove the hardcoded version number and version name, maybe it'd be possible to pull these from the tag too (i've generally made sure that tags have the named version as the description)

the question then becomes what do we do for builds that aren't releases - we'll still need to set a version number, maybe for the name we could just have "MacReady" for the named release branch and then "Nightly" or "Develop" for the main dev branch

in general i'd be very happy to see the extra info make it into the builds, i just want to make sure we think through all of the use cases we want to support

[Pepe20129]

the question then becomes what do we do for builds that aren't releases - we'll still need to set a version number, maybe for the name we could just have "MacReady" for the named release branch and then "Nightly" or "Develop" for the main dev branch

Do you mean for it to be just MacReady/Develop with no second part?
If so we would still need to have MacReady somewhere in there as I see no way of getting it from the branch reliably.

[briaguya-ai]

so i'm not quite sure what we'd want to set those values to when not on a tagged version, but i'm thinking we could just not show them on the logo screen when not on a tagged version

i'm still really hoping we can figure out a way to use the git tag description to set the version name for tagged versions instead of needing to hardcode it, it seems we can get that by using

git cat-file tag <tag_version> | sed '1,/^$/d'

but in my quick poking around i wasn't able to get that working in cmake

basically i'm hoping we can do

project(Ship VERSION "${GIT_COMMIT_TAG}" LANGUAGES C CXX)
set(PROJECT_BUILD_NAME "${GIT_TAG_DESCRIPTION}" CACHE STRING "")

when we have a tag, and then maybe just do

project(Ship VERSION 0.0.0 LANGUAGES C CXX)
set(PROJECT_BUILD_NAME "Unreleased" CACHE STRING "")

when we don't have a tag?

[Archez]

I'm a bit hesitant on 0.0.0 since that version info is what gets stored into the game otrs and is used for enforcing the regenerate flow. I know what we have isn't great either since the develop branch wont complain about an otr from the current release.

[Archez]

Approving as-is.

I know there was still conversation about potentially pulling out tag/release name info out of source entirely, but the original goal of this PR was to make tracing what commit a nightly build actually came from which would be good to merge in as testing for rando V3 increases. We can always open a separate issue to track the conversation about tag/release name in source.

[briaguya-ai]

I know there was still conversation about potentially pulling out tag/release name info out of source entirely,

100% agree that can be a separate PR

could we make it so we only show the version number and name on tagged builds? i expect people would say "i'm on macready foxtrot develop rando" if we show both on the title screen when reporting from test builds - i think it'd be clearer to only show the branch name and commit sha instead

[Pepe20129]

could we make it so we only show the version number and name on tagged builds? i expect people would say "i'm on macready foxtrot develop rando" if we show both on the title screen when reporting from test builds - i think it'd be clearer to only show the branch name and commit sha instead

I don't think that's a good idea as with the version and name there we can also quickly know if a build is severely outdated in the future.

[briaguya-ai]

quickly know if a build is severely outdated in the future

wouldn't the date do that?

[Pepe20129]

I forgot about the date.

[briaguya-ai]