如何为Git仓库生成REUSE/SPDX信息并降低手动标注工作量

简介 #

由欧洲自由软件基金会发起的REUSE项目开发的REUSE工具，能在细粒度层面添加、维护和提取详细的版权与许可信息，采用的格式同时具备人类可读性与机器可读性，是一款实用的工具。

不过这类信息属于静态跟踪信息，大多存储在源文件头部注释中，需要持续维护；对于已有项目而言，初始创建这些信息尤为重要，但手动完成这项工作繁琐又枯燥——毕竟很多信息可以从Git提交元数据中提取。

问题 #

如何降低为已有项目初始标注REUSE信息的手动工作量？

实用解决方案 #

• 自动提取Git提交元数据：使用REUSE工具自带的Git信息提取功能，执行命令：reuse annotate --copyright-from-git，工具会自动分析每个文件的提交历史，提取作者和版权年份，批量添加到文件头部注释。
• 批量添加统一许可声明：如果项目采用统一许可证，用reuse addheader --license <许可证标识>批量处理所有文件，比如：reuse addheader --license GPL-3.0-or-later。
• 通过配置文件批量定义规则：在项目根目录创建.reuse/dep5文件，批量指定目录或文件的版权与许可规则，无需逐个修改文件。示例配置：

  [Files]
  src/**/*
  Copyright: 2010-2024 项目贡献者
  License: GPL-3.0-or-later
  

• 排除无关文件：通过.reuse/ignore或.gitignore标记第三方依赖、构建产物等无需标注的文件，避免工具处理无关内容，提升效率。
• 自动化后续维护：配置Git提交钩子，在每次提交前运行reuse lint检查，提前发现缺失的REUSE信息，减少后续补全的工作量。

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