mpo/VVVVVV
1
0
Fork 0
mirror of https://github.com/TerryCavanagh/VVVVVV.git synced 2024-11-04 18:29:41 +01:00
Code Issues Releases Wiki Activity
VVVVVV/desktop_version/version.cmake

26 lines
755 B
CMake
Raw Normal View History

Update commit hash every time it changes, not just when CMake is re-ran The commit hash is now properly updated every time it gets changed, and not just when CMake gets re-ran. For this to work, we need to use a few CMake tricks. We add a custom target with ADD_CUSTOM_TARGET(), which is apparently always considered out-of-date (but I had to add a BYPRODUCTS line to get it to actually work), and we use the target to run a .cmake file every time we build. Also, VVVVVV needs to depend on this custom target, to ensure that the game gets built AFTER the version gets generated - otherwise there'll be an error. So we do an ADD_DEPENDENCIES() after the ADD_EXECUTABLE() for VVVVVV. This file, version.cmake, is just the Version.h.out generation that I added previously, but the important thing about all of this is that if the contents of Version.h.out doesn't change, and thus if the commit hash hasn't changed, then CMake will never recompile and relink anything at all. (At least with the Ninja generator.) On a small note, since the Version.h.out generation is now a separate script that is guaranteed to get ran on every single build, while the Git FIND_PACKAGE() gets ran only at configure time, it is possible for the cached path of the Git executable to get out of date. Fixing this requires a simple re-configure (ideally), but in case it wasn't fixed, the INTERIM_COMMIT and COMMIT_DATE variables would get set to empty strings instead of containing a value. To prevent this from happening, I've removed ERROR_QUIET from the EXECUTE_PROCESS() calls in version.cmake, because it's better to explicitly error if the Git executable wasn't found than implicitly carry on like nothing happened.
2020-12-26 05:24:14 +01:00
# Expects INPUT_FILE and OUTPUT_FILE to be defined
# Get interim commit and date of commit
EXECUTE_PROCESS(
Untabify every single file YOLO. This is a repeat of #642. As before, I just did rg -l '\t' | xargs -n 1 sed -i -e 's/\t/ /g' inside the desktop_version/ folder.
2021-09-07 03:56:39 +02:00
COMMAND "${GIT_EXECUTABLE}" log -1 --format=%h
OUTPUT_VARIABLE INTERIM_COMMIT
OUTPUT_STRIP_TRAILING_WHITESPACE
Update commit hash every time it changes, not just when CMake is re-ran The commit hash is now properly updated every time it gets changed, and not just when CMake gets re-ran. For this to work, we need to use a few CMake tricks. We add a custom target with ADD_CUSTOM_TARGET(), which is apparently always considered out-of-date (but I had to add a BYPRODUCTS line to get it to actually work), and we use the target to run a .cmake file every time we build. Also, VVVVVV needs to depend on this custom target, to ensure that the game gets built AFTER the version gets generated - otherwise there'll be an error. So we do an ADD_DEPENDENCIES() after the ADD_EXECUTABLE() for VVVVVV. This file, version.cmake, is just the Version.h.out generation that I added previously, but the important thing about all of this is that if the contents of Version.h.out doesn't change, and thus if the commit hash hasn't changed, then CMake will never recompile and relink anything at all. (At least with the Ninja generator.) On a small note, since the Version.h.out generation is now a separate script that is guaranteed to get ran on every single build, while the Git FIND_PACKAGE() gets ran only at configure time, it is possible for the cached path of the Git executable to get out of date. Fixing this requires a simple re-configure (ideally), but in case it wasn't fixed, the INTERIM_COMMIT and COMMIT_DATE variables would get set to empty strings instead of containing a value. To prevent this from happening, I've removed ERROR_QUIET from the EXECUTE_PROCESS() calls in version.cmake, because it's better to explicitly error if the Git executable wasn't found than implicitly carry on like nothing happened.
2020-12-26 05:24:14 +01:00
)
EXECUTE_PROCESS(
Fix %cs showing instead of commit date on Windows (or older git?) Whenever I'd compile on Windows, I'd see the literal text "%cs" in the main menu instead of the commit date. I never thought much of it (at least it runs, and the date only shows up in development builds). Now that I've also seen a screenshot from Terry with it, I decided to look into it further. Looks like it's a format string that our gits on Windows aren't recognizing for whatever reason - probably because they're too old. I have git version 2.23.0.windows.1, and checking its help page for `git log`, under PRETTY FORMATS, %cs is missing as an option, while some other options are still there. So the option was probably added sometime between that version and 2.34.1, which is the one I have on Linux, where %cs does work. Luckily, %cd with --date=short seems equivalent, and better supported, so we can just use that instead.
2023-11-13 19:53:42 +01:00
COMMAND "${GIT_EXECUTABLE}" log -1 --format=%cd --date=short
Untabify every single file YOLO. This is a repeat of #642. As before, I just did rg -l '\t' | xargs -n 1 sed -i -e 's/\t/ /g' inside the desktop_version/ folder.
2021-09-07 03:56:39 +02:00
OUTPUT_VARIABLE COMMIT_DATE
OUTPUT_STRIP_TRAILING_WHITESPACE
Update commit hash every time it changes, not just when CMake is re-ran The commit hash is now properly updated every time it gets changed, and not just when CMake gets re-ran. For this to work, we need to use a few CMake tricks. We add a custom target with ADD_CUSTOM_TARGET(), which is apparently always considered out-of-date (but I had to add a BYPRODUCTS line to get it to actually work), and we use the target to run a .cmake file every time we build. Also, VVVVVV needs to depend on this custom target, to ensure that the game gets built AFTER the version gets generated - otherwise there'll be an error. So we do an ADD_DEPENDENCIES() after the ADD_EXECUTABLE() for VVVVVV. This file, version.cmake, is just the Version.h.out generation that I added previously, but the important thing about all of this is that if the contents of Version.h.out doesn't change, and thus if the commit hash hasn't changed, then CMake will never recompile and relink anything at all. (At least with the Ninja generator.) On a small note, since the Version.h.out generation is now a separate script that is guaranteed to get ran on every single build, while the Git FIND_PACKAGE() gets ran only at configure time, it is possible for the cached path of the Git executable to get out of date. Fixing this requires a simple re-configure (ideally), but in case it wasn't fixed, the INTERIM_COMMIT and COMMIT_DATE variables would get set to empty strings instead of containing a value. To prevent this from happening, I've removed ERROR_QUIET from the EXECUTE_PROCESS() calls in version.cmake, because it's better to explicitly error if the Git executable wasn't found than implicitly carry on like nothing happened.
2020-12-26 05:24:14 +01:00
)
Add branch name to interim version information This is useful for developers who may have multiple builds of the game from various different branches and may easily forget which build of the game is what. This shows up in the bottom-right corner of the title screen and also with the `-version` command-line option, and in the status message printed when building the game.
2023-01-08 04:18:28 +01:00
EXECUTE_PROCESS(
COMMAND "${GIT_EXECUTABLE}" branch --show-current
OUTPUT_VARIABLE BRANCH_NAME
OUTPUT_STRIP_TRAILING_WHITESPACE
)
MESSAGE(STATUS "This is interim commit ${INTERIM_COMMIT} (committed ${COMMIT_DATE}) on branch ${BRANCH_NAME}")
Update commit hash every time it changes, not just when CMake is re-ran The commit hash is now properly updated every time it gets changed, and not just when CMake gets re-ran. For this to work, we need to use a few CMake tricks. We add a custom target with ADD_CUSTOM_TARGET(), which is apparently always considered out-of-date (but I had to add a BYPRODUCTS line to get it to actually work), and we use the target to run a .cmake file every time we build. Also, VVVVVV needs to depend on this custom target, to ensure that the game gets built AFTER the version gets generated - otherwise there'll be an error. So we do an ADD_DEPENDENCIES() after the ADD_EXECUTABLE() for VVVVVV. This file, version.cmake, is just the Version.h.out generation that I added previously, but the important thing about all of this is that if the contents of Version.h.out doesn't change, and thus if the commit hash hasn't changed, then CMake will never recompile and relink anything at all. (At least with the Ninja generator.) On a small note, since the Version.h.out generation is now a separate script that is guaranteed to get ran on every single build, while the Git FIND_PACKAGE() gets ran only at configure time, it is possible for the cached path of the Git executable to get out of date. Fixing this requires a simple re-configure (ideally), but in case it wasn't fixed, the INTERIM_COMMIT and COMMIT_DATE variables would get set to empty strings instead of containing a value. To prevent this from happening, I've removed ERROR_QUIET from the EXECUTE_PROCESS() calls in version.cmake, because it's better to explicitly error if the Git executable wasn't found than implicitly carry on like nothing happened.
2020-12-26 05:24:14 +01:00
# Take the template file and replace the macros with what we have
CONFIGURE_FILE(${INPUT_FILE} ${OUTPUT_FILE})
Reference in a new issue Copy permalink