如何将git commit-number包含到c ++可执行文件中？

Question

我使用git作为我的c ++项目的版本跟踪器。

有时我需要重复计算，我想知道我使用的程序版本。

将＃提交放入主可执行文件的好方法是什么？换一种说法。我希望程序在运行程序时告诉我介绍性消息中当前提交的＃。

我能想到的一种方法是让shell中的c ++程序午餐“git log”并提取commit＃但是我不确定如何在make期间执行它。

（我使用linux）

Answer 1

可能最简单的方法是在makefile中添加一条规则来生成一个带有当前git提交ID的.c文件：

gitversion.c: .git/HEAD .git/index
    echo "const char *gitversion = \"$(shell git rev-parse HEAD)\";" > $@

现在只需将gitversion.c正常添加到您的构建过程中。确保在make clean上删除它，并将其添加到.gitignore，因此它不会意外地添加到git存储库中。将extern const char *gitversion;添加到某个地方的标题中，您可以像这样访问它。

Answer 2

我在CMakeLists.txt中执行以下操作：

IF(EXISTS ${CMAKE_CURRENT_SOURCE_DIR}/.git)
  FIND_PACKAGE(Git)
  IF(GIT_FOUND)
    EXECUTE_PROCESS(
      COMMAND ${GIT_EXECUTABLE} rev-parse --short HEAD
      WORKING_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}"
      OUTPUT_VARIABLE "kml2maps_BUILD_VERSION"
      ERROR_QUIET
      OUTPUT_STRIP_TRAILING_WHITESPACE)
    MESSAGE( STATUS "Git version: ${kml2maps_BUILD_VERSION}" )
  ELSE(GIT_FOUND)
    SET(kml2maps_BUILD_VERSION 0)
  ENDIF(GIT_FOUND)
ENDIF(EXISTS ${CMAKE_CURRENT_SOURCE_DIR}/.git)

CONFIGURE_FILE(${CMAKE_CURRENT_SOURCE_DIR}/kml2mapsVersion.h.in ${CMAKE_CURRENT_BINARY_DIR}/kml2mapsVersion.h @ONLY)

所以git rev-parse --short HEAD的输出很好地构建在二进制文件中。

Answer 3

我使用git describe来获得一个使用标签或提交号码的版本。这通常会提供很好的版本，例如：v0.1-1-g787c667，如果分支的提示在“v0.1”标记之上有额外的提交。

我使用的git命令是：git describe --tags --always。我通常将它与SCons构建系统一起使用，并将其定义为SConstruct的常量相关部分：

import os, sys 
from subprocess import *

def getGitDesc():   
  return Popen('git describe --tags --always', stdout=PIPE, shell=True).stdout.read ().strip ()

GIT_DESC = getGitDesc () 
print "Building " + getGitDesc () + ".." 
env = Environment ()

# set up environment 
env.Append (CPPDEFINES = { 'GIT_DESC' : ('\\"%s\\"' % GIT_DESC) } )

# build your program
env.Program (....)

在C或C ++程序中，我现在可以访问GIT_DESC作为字符串常量：

# include <iostream>

using namespace std;

int main (int argc, char ** argv) {
  cout << "Version: " << GIT_DESC << endl;
  return 42;
}

注意：--abbrev=N的git describe参数可能对于实现独立于用户git配置的一致版本输出很有用。

Answer 4

如果您正在使用Qt，请将其放在项目的.pro文件中：

win32:DEFINES += GIT_BIN='C:\\Git\\bin\\git'
# or 'C:\\Progra~1\\Git\\bin\\git' - ymmv with putting spaces in here
win32:DEFINES += GIT_REVISION='\\"$$system($${GIT_BIN} rev-parse --short HEAD)\\"'
unix:DEFINES += GIT_REVISION='\\"$$system(git rev-parse --short HEAD)\\"'

然后在代码中使用GIT_REVISION，就像在其他答案中一样 - 它表现为const char *。

（感谢亚历山大巴塞尔，我掠夺了这个小费。）