fsfe/reuse

reuse 镜像文档

镜像概述与主要用途

reuse 镜像是一个用于遵循 REUSE 倡议建议的合规性工具，由 Free Software Foundation Europe (FSFE) 开发。该工具旨在简化软件项目中的版权和许可管理，通过检查文件头注释、许可证文件位置及格式等，确保项目符合 REUSE 规范，便于开发者声明作品许可、帮助计算机理解项目许可信息。

核心功能与特性

• 合规性检查：通过 lint 命令验证项目是否符合 REUSE 3.0 规范
• 许可管理：支持将许可证文件放置于 LICENSES/ 目录并进行管理
• 注释生成：可自动添加 SPDX 格式的版权和许可头注释（SPDX-License-Identifier 和 SPDX-FileCopyrightText）
• SPDX 文档生成：通过 spdx 命令生成 SPDX 格式的许可声明文档
• 多版本控制系统支持：兼容 Git、Mercurial 4.3+ 和 Pijul
• 灵活集成：支持 Docker 容器化运行，可集成到 CI/CD 流程或作为 Git pre-commit 钩子

使用场景与适用范围

• 软件开发项目：管理多文件版权与许可信息，确保开源合规性
• 团队协作：统一项目许可声明规范，简化跨团队协作中的许可审核
• CI/CD 流程：在构建过程中自动检查许可合规性，避免不合规代码提交
• 代码提交检查：作为 pre-commit 钩子，在提交前验证文件许可头完整性

详细使用方法与配置说明

Docker 部署示例

基础检查命令

将当前项目目录挂载到容器的 /data 工作目录，运行合规性检查：

bash
docker run --rm --volume $(pwd):/data fsfe/reuse lint

带额外参数的命令

生成 SPDX 文档并指定输出文件：

bash
docker run --rm --volume $(pwd):/data fsfe/reuse --include-submodules spdx -o out.spdx

初始化项目

在新项目中初始化 REUSE 规范结构（创建 LICENSES 目录等）：

bash
docker run --rm --volume $(pwd):/data fsfe/reuse init

镜像标签说明

reuse 镜像提供多种标签选择，满足不同版本需求：

• latest：最新发布版本
• {major}：最新主版本（如 v3）
• {major}.{minor}：最新次版本（如 v3.0）
• {major}.{minor}.{patch}：精确补丁版本（如 v3.0.1）
• 所有标签均可添加 -debian 后缀（如 latest-debian），使用 Debian 基础镜像（体积较大但可能更适合严格许可合规场景）

配置说明

• 工作目录：容器默认工作目录为 /data，需通过 --volume 挂载项目目录至此路径
• 用户权限：运行时建议挂载当前用户目录以避免权限问题（如 Linux 下可添加 --user $(id -u):$(id -g)）
• 环境变量：无特殊环境变量需求，所有配置通过命令行参数传递

其他安装与使用方式（补充说明）

除 Docker 外，reuse 还支持以下安装方式（非 Docker 镜像核心内容，仅供参考）：

通过 pipx 安装（推荐）

bash
pipx install reuse
reuse lint  # 运行检查

作为 pre-commit 钩子

在 .pre-commit-config.yaml 中添加：

yaml
repos:
  - repo: https://github.com/fsfe/reuse-tool
    rev: v3.0.1
    hooks:
      - id: reuse

维护者与贡献

• 维护者：Carmen Bianca Bakker、Max Mehl、Linus Sehn
• 贡献方式：可通过 GitHub 仓库（https://github.com/fsfe/reuse-tool%EF%BC%89%E6%8F%90%E4%BA%A4 bug 报告、功能请求或 PR，或参与邮件列表讨论（***）

许可证

reuse 工具采用多许可证授权，主要组件许可如下：

• 原始源代码：GPL-3.0-or-later
• 文档：CC-BY-SA-4.0
• 配置和数据文件：CC0-1.0
• 部分借鉴自 spdx/tools-python 的代码：Apache-2.0

详细信息请查阅各文件头部的 SPDX 许可声明。