如何在内部项目的Debian包中嵌入Git信息及自定义元数据？

核心思路 #

避免手动维护GIT-VERSION这类文件，而是通过Debian打包规则（debian/rules）自动生成元数据文件，并遵循Debian文件系统规范放置，确保每次构建的信息准确同步。

方法1：构建阶段自动生成并安装元数据文件 #

在debian/rules中添加自定义构建规则，自动提取Git信息和JIRA链接，生成文件后安装到标准路径：

1. 编辑debian/rules，添加或追加override_dh_auto_build规则：

override_dh_auto_build:
    dh_auto_build  # 保留原有构建逻辑
    # 创建目标目录（确保存在）
    mkdir -p debian/$(PACKAGE)/usr/share/$(PACKAGE)
    # 生成Git元数据
    echo "Git Remote: $(shell git remote get-url origin)" > debian/$(PACKAGE)/usr/share/$(PACKAGE)/build-info.txt
    echo "Git Commit Hash: $(shell git rev-parse HEAD)" >> debian/$(PACKAGE)/usr/share/$(PACKAGE)/build-info.txt
    echo "Git Branch: $(shell git rev-parse --abbrev-ref HEAD)" >> debian/$(PACKAGE)/usr/share/$(PACKAGE)/build-info.txt
    # 添加JIRA链接（示例：从项目根目录的JIRA-TICKET文件读取，或直接指定/从环境变量获取）
    echo "JIRA Ticket: $(shell cat JIRA-TICKET 2>/dev/null || echo 'N/A')" >> debian/$(PACKAGE)/usr/share/$(PACKAGE)/build-info.txt

2. 确保debian/control中定义了$(PACKAGE)变量（通常默认已设置），或者直接替换成你的包名。

方法2：使用dh_install管理元数据文件 #

如果希望更清晰地管理安装文件，可配合dh_install工具：

1. 在项目根目录生成元数据文件（通过debian/rules触发）：

override_dh_auto_build:
    dh_auto_build
    # 生成元数据到项目根目录
    echo "Git Remote: $(shell git remote get-url origin)" > build-info.txt
    echo "Git Commit: $(shell git rev-parse HEAD)" >> build-info.txt
    echo "JIRA Ticket: JIRA-1234" >> build-info.txt

2. 创建debian/<your-package>.install文件，添加一行：

build-info.txt usr/share/<your-package>/

dh_install会自动将该文件复制到包内的指定路径。

关键注意事项 #

• 路径规范：元数据文件应放在/usr/share/<package>/（共享数据目录），符合Debian文件系统标准，不要放在根目录或非标准路径。
• CI环境适配：如果在无完整Git仓库的CI环境构建，可通过环境变量传递Git信息（如GIT_COMMIT、GIT_REMOTE），修改规则读取环境变量而非执行Git命令：

  echo "Git Commit Hash: $(GIT_COMMIT)" >> debian/$(PACKAGE)/usr/share/$(PACKAGE)/build-info.txt
  

• 避免构建污染：生成的元数据文件不要提交到Git仓库，可添加到.gitignore。

替代方案：嵌入到二进制文件（可选） #

如果是编译型项目，可将Git信息作为编译参数嵌入二进制：

override_dh_auto_build:
    dh_auto_build -- CPPFLAGS="-DGIT_COMMIT='\"$(shell git rev-parse HEAD)\"' -DJIRA_TICKET='\"JIRA-1234\"'"

之后在代码中通过这些宏获取元数据，适合需要在程序运行时直接展示版本信息的场景。

内容的提问来源于stack exchange，提问作者forvaidya