From 11a67f11a95560e596c91339f167ff1ab431568f Mon Sep 17 00:00:00 2001 From: Alexander Borsuk Date: Thu, 30 Dec 2021 01:55:33 +0100 Subject: [PATCH] Unified app version for all platforms Signed-off-by: Alexander Borsuk --- .gitignore | 1 - CMakeLists.txt | 30 ++++++---- android/build.gradle | 28 +-------- android/src/com/mapswithme/util/Utils.java | 15 +++++ build_version.hpp.in | 13 +--- cmake/BuildVersion.cmake | 60 ------------------- cmake/OmimHelpers.cmake | 4 +- .../complex_generator/complex_generator.cpp | 3 +- generator/generator_tool/generator_tool.cpp | 3 +- iphone/Maps/UI/Settings/MWMAboutController.m | 2 +- qt/about.cpp | 25 ++------ qt/main.cpp | 3 + tools/unix/version.sh | 53 ++++++++++++++++ xcode/fastlane/Fastfile | 8 +-- 14 files changed, 108 insertions(+), 140 deletions(-) delete mode 100644 cmake/BuildVersion.cmake create mode 100755 tools/unix/version.sh diff --git a/.gitignore b/.gitignore index 8dbd6ce506..8d7181f6bb 100644 --- a/.gitignore +++ b/.gitignore @@ -76,7 +76,6 @@ iphone/Maps/3party/Carthage/Build/iOS/*.dSYM iphone/Maps/3party/Carthage/Build/*.version # GeneratedFiles -version/version.hpp tools/win/MapsWithMe* GeneratedFiles diff --git a/CMakeLists.txt b/CMakeLists.txt index ca9758a5aa..9a6437bff2 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -8,7 +8,7 @@ set(CMAKE_C_STANDARD 11) set(CMAKE_CXX_EXTENSIONS OFF) set(CMAKE_C_EXTENSIONS OFF) -if(NOT (DEFINED ENV{COLORS_DISABLE}) AND CMAKE_CXX_COMPILER_ID MATCHES "GNU|Clang") +if (NOT (DEFINED ENV{COLORS_DISABLE}) AND CMAKE_CXX_COMPILER_ID MATCHES "GNU|Clang") message(STATUS "export COLORS_DISABLE=1 to disable colored compiler output.") add_compile_options($<$:-fdiagnostics-color=always> $<$:-fcolor-diagnostics>) add_link_options($<$:-fdiagnostics-color=always> $<$:-fcolor-diagnostics>) @@ -268,6 +268,25 @@ if (USE_PCH) ) endif() +# Generate version header file. +execute_process(COMMAND tools/unix/version.sh android_name + WORKING_DIRECTORY ${CMAKE_SOURCE_DIR} + OUTPUT_VARIABLE OM_VERSION + OUTPUT_STRIP_TRAILING_WHITESPACE +) +execute_process(COMMAND tools/unix/version.sh android_code + WORKING_DIRECTORY ${CMAKE_SOURCE_DIR} + OUTPUT_VARIABLE OM_VERSION_CODE + OUTPUT_STRIP_TRAILING_WHITESPACE +) +execute_process(COMMAND tools/unix/version.sh git_hash + WORKING_DIRECTORY ${CMAKE_SOURCE_DIR} + OUTPUT_VARIABLE OM_GIT_HASH + OUTPUT_STRIP_TRAILING_WHITESPACE +) +# TODO: Does it run on every build or only on configure step? +# TODO: Run only when dependent targets are built. +configure_file(build_version.hpp.in ${CMAKE_SOURCE_DIR}/build_version.hpp @ONLY) # Include 3party dependencies. @@ -361,12 +380,3 @@ omim_add_test_subdirectory(qt_tstfrm) if (PLATFORM_ANDROID) add_subdirectory(android/jni) endif() - -add_custom_target(BuildVersion ALL - COMMAND ${CMAKE_COMMAND} - ARGS - -D OMAPS_CURRENT_PROJECT_ROOT=${OMIM_ROOT} - -D PATH_WITH_BUILD_VERSION_HPP=${OMIM_ROOT} - -D PROJECT_NAME=${PROJECT_NAME} - -P ${OMIM_ROOT}/cmake/BuildVersion.cmake -) diff --git a/android/build.gradle b/android/build.gradle index eaf1856566..ec331aa76b 100644 --- a/android/build.gradle +++ b/android/build.gradle @@ -112,30 +112,8 @@ def run(cmd) { } def getVersion() { - def time = Integer.parseInt(run(['git', 'log', '-1', '--format=%ct']).trim()) - def cal = Calendar.getInstance(TimeZone.getTimeZone("UTC"), Locale.ENGLISH) - cal.setTimeInMillis((long) time * 1000) - def year = cal.get(Calendar.YEAR) - def month = cal.get(Calendar.MONTH) + 1 - def day = cal.get(Calendar.DAY_OF_MONTH) - def date_of_last_commit = String.format("%04d-%02d-%02d", year, month, day) - def build = Integer.parseInt(run(['git', 'rev-list', '--count', '--after="' + date_of_last_commit + 'T00:00:00Z"', 'HEAD']).trim()) - - // Use the last git commit date to generate the version code: - // RR_yy_MM_dd_CC - // - RR - reserved to identify special markets, max value is 21. - // - yy - year - // - MM - month - // - dd - day - // - CC - the number of commits from the current day - // 21_00_00_00_00 is the the greatest value Google Play allows for versionCode. - // See https://developer.android.com/studio/publish/versioning for details. - def versionCode = (year - 2000) * 1_00_00_00 + month * 1_00_00 + day * 1_00 + build - - // Use the current date to generate the version name: - // 2021.04.11-12-Google (-Google added by flavor) - def versionName = String.format("%04d.%02d.%02d-%d", year, month, day, build) - + def versionCode = Integer.parseInt(run(['../tools/unix/version.sh', 'android_code']).trim()) + def versionName = run(['../tools/unix/version.sh', 'android_name']).trim() return new Tuple2(versionCode, versionName) } @@ -244,7 +222,7 @@ android { flavorDimensions "default" productFlavors { - // See getVersion() + // 01 is a historical artefact, sorry. final int HUAWEI_VERSION_CODE_BASE = 01_00_00_00_00 google { diff --git a/android/src/com/mapswithme/util/Utils.java b/android/src/com/mapswithme/util/Utils.java index 2706c90693..16194394c2 100644 --- a/android/src/com/mapswithme/util/Utils.java +++ b/android/src/com/mapswithme/util/Utils.java @@ -611,6 +611,21 @@ public class Utils return Build.MODEL; } + @NonNull + public static String getVersion() + { + return BuildConfig.VERSION_NAME; + } + + @NonNull + public static int getIntVersion() + { + // Please sync with getVersion() in build.gradle + // - % 100000000 removes prefix for special markets, e.g Huawei. + // - / 100 removes the number of commits in the current day. + return (BuildConfig.VERSION_CODE % 1_00_00_00_00) / 100; + } + @NonNull public static T[] concatArrays(@Nullable T[] a, T... b) { diff --git a/build_version.hpp.in b/build_version.hpp.in index 14fb883592..373ebbcbb9 100644 --- a/build_version.hpp.in +++ b/build_version.hpp.in @@ -1,18 +1,9 @@ -// A helper file that may be used to inject the git commit hash and the build time into a binary. #pragma once #include -namespace @PROJECT_NAME@ -{ namespace build_version { -namespace git -{ -constexpr char const * const kHash = "@GIT_HASH@"; -constexpr char const * const kTag = "@GIT_TAG@"; -constexpr uint64_t kTimestamp = @GIT_TIMESTAMP@; -constexpr char const * const kProjectName = "@PROJECT_NAME@"; -} // namespace git +constexpr uint64_t kCode = @OM_VERSION_CODE@; +constexpr char const * const kName = "@OM_VERSION@ (@OM_GIT_HASH@)"; } // namespace build_version -} // namespace @PROJECT_NAME@ diff --git a/cmake/BuildVersion.cmake b/cmake/BuildVersion.cmake deleted file mode 100644 index f990750267..0000000000 --- a/cmake/BuildVersion.cmake +++ /dev/null @@ -1,60 +0,0 @@ -function(get_last_git_commit_hash result_name) - execute_process(COMMAND - "${GIT_EXECUTABLE}" describe --match="" --always --abbrev=40 --dirty - WORKING_DIRECTORY "${OMAPS_CURRENT_PROJECT_ROOT}" - OUTPUT_VARIABLE GIT_HASH - RESULT_VARIABLE status - ERROR_QUIET OUTPUT_STRIP_TRAILING_WHITESPACE) - - if (status STREQUAL "0") - set(${result_name} ${GIT_HASH} PARENT_SCOPE) - else() - message(WARNING "Failed to get hash for last commit from git.") - endif() -endfunction() - -function(get_last_git_commit_timestamp result_name) - execute_process(COMMAND - "${GIT_EXECUTABLE}" show -s --format=%ct HEAD - WORKING_DIRECTORY "${OMAPS_CURRENT_PROJECT_ROOT}" - OUTPUT_VARIABLE GIT_TIMESTAMP - RESULT_VARIABLE status - ERROR_QUIET OUTPUT_STRIP_TRAILING_WHITESPACE) - - if (status STREQUAL "0") - set(${result_name} ${GIT_TIMESTAMP} PARENT_SCOPE) - else() - message(WARNING "Failed to get timestamp for last commit from git.") - endif() -endfunction() - -function(get_git_tag_name result_name) - execute_process(COMMAND - "${GIT_EXECUTABLE}" tag --points-at HEAD - WORKING_DIRECTORY "${OMAPS_CURRENT_PROJECT_ROOT}" - OUTPUT_VARIABLE GIT_TAG - RESULT_VARIABLE status - ERROR_QUIET OUTPUT_STRIP_TRAILING_WHITESPACE) - - if (status STREQUAL "0") - set(${result_name} ${GIT_TAG} PARENT_SCOPE) - else() - message(WARNING "Failed to get tag for last commit from git.") - endif() -endfunction() - -function(configure_build_version_hpp) - message(STATUS "Configure build version ...") - set(GIT_HASH "") - set(GIT_TIMESTAMP "0") - set(GIT_TAG "") - find_package(Git) - if (GIT_FOUND) - get_last_git_commit_hash(GIT_HASH) - get_last_git_commit_timestamp(GIT_TIMESTAMP) - get_git_tag_name(GIT_TAG) - endif() - configure_file("${PATH_WITH_BUILD_VERSION_HPP}/build_version.hpp.in" "${OMAPS_CURRENT_PROJECT_ROOT}/build_version.hpp" @ONLY) -endfunction() - -configure_build_version_hpp() diff --git a/cmake/OmimHelpers.cmake b/cmake/OmimHelpers.cmake index 6e9a018d06..f242afaf47 100644 --- a/cmake/OmimHelpers.cmake +++ b/cmake/OmimHelpers.cmake @@ -25,7 +25,7 @@ endfunction() # Functions for using in subdirectories function(omim_add_executable executable) add_executable(${executable} ${ARGN}) - add_dependencies(${executable} BuildVersion) + # Enable warnings for all our binaries. target_compile_options(${executable} PRIVATE ${OMIM_WARNING_FLAGS}) target_include_directories(${executable} PRIVATE ${OMIM_INCLUDE_DIRS}) @@ -71,7 +71,7 @@ endfunction() function(omim_add_library library) add_library(${library} ${ARGN}) - add_dependencies(${library} BuildVersion) + # Enable warnings for all our libraries. target_compile_options(${library} PRIVATE ${OMIM_WARNING_FLAGS}) target_include_directories(${library} PRIVATE ${OMIM_INCLUDE_DIRS}) diff --git a/generator/complex_generator/complex_generator.cpp b/generator/complex_generator/complex_generator.cpp index ebdeeddc4c..41f88981e9 100644 --- a/generator/complex_generator/complex_generator.cpp +++ b/generator/complex_generator/complex_generator.cpp @@ -65,8 +65,7 @@ MAIN_WITH_ERROR_HANDLING([](int argc, char ** argv) { "complex_generator is a program that generates complexes on the basis of " "the last generation of maps. Complexes are a hierarchy of interesting " "geographical features."); - gflags::SetVersionString(std::to_string(omim::build_version::git::kTimestamp) + " " + - omim::build_version::git::kHash); + gflags::SetVersionString(build_version::kName); gflags::ParseCommandLineFlags(&argc, &argv, true); Platform & pl = GetPlatform(); diff --git a/generator/generator_tool/generator_tool.cpp b/generator/generator_tool/generator_tool.cpp index 2575239763..7382c13edb 100644 --- a/generator/generator_tool/generator_tool.cpp +++ b/generator/generator_tool/generator_tool.cpp @@ -215,8 +215,7 @@ MAIN_WITH_ERROR_HANDLING([](int argc, char ** argv) gflags::SetUsageMessage( "Takes OSM XML data from stdin and creates data and index files in several passes."); - gflags::SetVersionString(std::to_string(omim::build_version::git::kTimestamp) + " " + - omim::build_version::git::kHash); + gflags::SetVersionString(build_version::kName); gflags::ParseCommandLineFlags(&argc, &argv, true); Platform & pl = GetPlatform(); diff --git a/iphone/Maps/UI/Settings/MWMAboutController.m b/iphone/Maps/UI/Settings/MWMAboutController.m index 731d871fb0..129ab12b26 100644 --- a/iphone/Maps/UI/Settings/MWMAboutController.m +++ b/iphone/Maps/UI/Settings/MWMAboutController.m @@ -38,7 +38,7 @@ AppInfo * appInfo = [AppInfo sharedInfo]; NSString * version = appInfo.bundleVersion; if (appInfo.buildNumber) - version = [NSString stringWithFormat:@"%@.%@", version, appInfo.buildNumber]; + version = [NSString stringWithFormat:@"%@-%@", version, appInfo.buildNumber]; self.versionLabel.text = [NSString stringWithFormat:L(@"version"), version]; self.dataVersionLabel.text = [NSString stringWithFormat:L(@"data_version"), [MWMFrameworkHelper dataVersion]]; diff --git a/qt/about.cpp b/qt/about.cpp index 65137b9cbf..e2d3da0a49 100644 --- a/qt/about.cpp +++ b/qt/about.cpp @@ -4,6 +4,8 @@ #include "base/logging.hpp" +#include "build_version.hpp" + #include #include @@ -14,14 +16,6 @@ #include #include -#ifdef USE_DESIGNER_VERSION - #include "designer_version.h" -#else - #define DESIGNER_APP_VERSION "" - #define DESIGNER_CODEBASE_SHA "" - #define DESIGNER_DATA_VERSION "" -#endif // BUILD_DESIGNER - AboutDialog::AboutDialog(QWidget * parent) : QDialog(parent, Qt::WindowTitleHint | Qt::WindowSystemMenuHint) { @@ -32,24 +26,15 @@ AboutDialog::AboutDialog(QWidget * parent) QLabel * labelIcon = new QLabel(); labelIcon->setPixmap(icon.pixmap(128)); -#ifndef BUILD_DESIGNER - // @todo insert version to bundle. - QLabel * labelVersion = new QLabel(qAppName()); - - QHBoxLayout * hBox = new QHBoxLayout(); - hBox->addWidget(labelIcon); - hBox->addWidget(labelVersion); -#else // BUILD_DESIGNER QVBoxLayout * versionBox = new QVBoxLayout(); versionBox->addWidget(new QLabel(qAppName())); - versionBox->addWidget(new QLabel(QString("Version: ") + DESIGNER_APP_VERSION)); - versionBox->addWidget(new QLabel(QString("Commit: ") + DESIGNER_CODEBASE_SHA)); - versionBox->addWidget(new QLabel(QString("Data: ") + DESIGNER_DATA_VERSION)); + versionBox->addWidget(new QLabel(QString("Version: ") + build_version::kName)); + // TODO: insert maps data version. + //versionBox->addWidget(new QLabel(QString("Data: ") + DESIGNER_DATA_VERSION)); QHBoxLayout * hBox = new QHBoxLayout(); hBox->addWidget(labelIcon); hBox->addLayout(versionBox); -#endif std::string aboutText; try diff --git a/qt/main.cpp b/qt/main.cpp index 7030954886..366e93fa67 100644 --- a/qt/main.cpp +++ b/qt/main.cpp @@ -14,6 +14,8 @@ #include "build_style/build_style.h" +#include "build_version.hpp" + #include #include #include @@ -118,6 +120,7 @@ int main(int argc, char * argv[]) (void)::setenv("LC_NUMERIC", "C", 1); gflags::SetUsageMessage("Desktop application."); + gflags::SetVersionString(build_version::kName); gflags::ParseCommandLineFlags(&argc, &argv, true); Platform & platform = GetPlatform(); diff --git a/tools/unix/version.sh b/tools/unix/version.sh new file mode 100755 index 0000000000..dde9f3a421 --- /dev/null +++ b/tools/unix/version.sh @@ -0,0 +1,53 @@ +#!/bin/bash + +set -euo pipefail + +function usage { + cat << EOF +Prints Organic Maps version in specified format. +Version is the last git commit's date plus a number of commits on that day. +Usage: $0 format +Where format is one of the following arguments: + ios_version 2021.12.26 + ios_build 3 + android_name 2021.12.26-3 + android_code 21122603 + git_hash abcdef01 +EOF +} + +DATE_OF_THE_LAST_COMMIT=$(git log -1 --date=format:%Y.%m.%d --pretty=format:%cd) +function commits_count { + git rev-list --count --after="${DATE_OF_THE_LAST_COMMIT//./-}T00:00:00Z" HEAD +} + +case "${1:-}" in + ios_version) + echo $DATE_OF_THE_LAST_COMMIT + ;; + ios_build) + commits_count + ;; + android_name) + echo $DATE_OF_THE_LAST_COMMIT-$(commits_count) + ;; + # RR_yy_MM_dd_CC + # RR - reserved to identify special markets, max value is 21. + # yy - year + # MM - month + # dd - day + # CC - the number of commits from the current day + # 21_00_00_00_00 is the the greatest value Google Play allows for versionCode. + # See https://developer.android.com/studio/publish/versioning for details. + android_code) + CUT_YEAR=${DATE_OF_THE_LAST_COMMIT:2} + echo ${CUT_YEAR//./}$(printf %02d $(commits_count)) + ;; + git_hash) + git describe --match="" --always --abbrev=8 --dirty + ;; + *) + usage + exit 1 + ;; +esac diff --git a/xcode/fastlane/Fastfile b/xcode/fastlane/Fastfile index e9c3ebefe8..8abdd60aec 100644 --- a/xcode/fastlane/Fastfile +++ b/xcode/fastlane/Fastfile @@ -45,12 +45,8 @@ platform :ios do end private_lane :generate_version do - timestamp = sh('git log -1 --format=%ct').strip - date_of_last_commit = sh('date -u -r ' + timestamp + " '+%Y-%m-%d'").strip - build_number = sh('git rev-list --count --after="' + date_of_last_commit + 'T00:00:00Z" HEAD').strip - version_number = date_of_last_commit.gsub!('-', '.') - lane_context[SharedValues::VERSION_NUMBER] = version_number - lane_context[SharedValues::BUILD_NUMBER] = build_number + lane_context[SharedValues::VERSION_NUMBER] = sh('../tools/unix/version.sh ios_version') + lane_context[SharedValues::BUILD_NUMBER] = sh('../tools/unix/version.sh ios_build') end private_lane :generate_testflight_changelog do