Rust许可证管理工具cargo-bundle-licenses的使用，自动收集和打包项目依赖的开源许可证文件

简介

cargo-bundle-licenses是一个Rust工具，用于将所有第三方许可证打包到一个文件中。

注意：该工具不能保证许可证选择的正确性。它依赖于包元数据中提供的信息，这些信息可能不准确。对于正式场景，建议手动检查和验证所有许可证。

安装

cargo install cargo-bundle-licenses

使用方法

典型的使用场景如下：

1. 生成初始的许可证捆绑文件：

cargo bundle-licenses --format yaml --output THIRDPARTY.yml

1. 检查列出的警告信息，跟踪无法找到的许可证，并将许可证文本粘贴到"THIRDPARTY.yml"文件中。

   • 如果许可证本应被cargo-bundle-licenses找到，请创建问题或提交拉取请求。

2. 在CI中，运行以下命令检查更改并在发现差异时失败：

cargo bundle-licenses --format yaml --output CI.yaml --previous THIRDPARTY.yml --check-previous

支持的格式

目前支持的格式有json、yaml和toml。

常见警告及解决方法

最常见的问题是工作区没有include转发其许可证文件。需要去工作区的仓库复制相关文件。

与其他工具的区别

• cargo-about：也查找并聚合所有依赖项的许可证文本。cargo-bundle-licenses更专注于生成内容并允许手动更新未找到的许可证。
• cargo-license：仅生成Cargo.toml文件中找到的许可证列表。
• cargo-deny：收集依赖项的许可证列表，但目的是警告或错误提示不可接受的许可证，不收集许可证文本。

完整示例

// 此示例展示如何在Cargo.toml中添加cargo-bundle-licenses作为依赖
[dependencies]
cargo-bundle-licenses = "4.0.0"

// 在build.rs中使用
fn main() {
    // 生成YAML格式的许可证文件
    std::process::Command::new("cargo")
        .arg("bundle-licenses")
        .arg("--format")
        .arg("yaml")
        .arg("--output")
        .arg("THIRDPARTY.yml")
        .status()
        .expect("Failed to bundle licenses");
}

# 在CI中检查许可证变更的示例脚本
#!/bin/bash

# 生成新的许可证文件
cargo bundle-licenses --format yaml --output CI.yaml --previous THIRDPARTY.yml --check-previous

# 如果有差异则失败
if [ $? -ne 0 ]; then
    echo "License changes detected! Please update THIRDPARTY.yml"
    exit 1
fi

完整示例demo

下面是一个完整的项目示例，展示如何在实际项目中使用cargo-bundle-licenses：

1. 首先创建项目结构：

my_project/
├── Cargo.toml
├── build.rs
├── src/
│   └── main.rs
└── licenses/
    └── THIRDPARTY.yml

1. Cargo.toml内容：

[package]
name = "my_project"
version = "0.1.0"
edition = "2021"

[dependencies]
serde = "1.0"
serde_json = "1.0"

[build-dependencies]
cargo-bundle-licenses = "4.0.0"

1. build.rs内容：

fn main() {
    // 生成YAML格式的许可证文件
    let status = std::process::Command::new("cargo")
        .arg("bundle-licenses")
        .arg("--format")
        .arg("yaml")
        .arg("--output")
        .arg("licenses/THIRDPARTY.yml")
        .status()
        .expect("Failed to execute command");

    if !status.success() {
        panic!("Failed to bundle licenses");
    }
}

1. CI检查脚本(ci_check_licenses.sh)：

#!/bin/bash

set -e

# 生成临时许可证文件用于比较
cargo bundle-licenses --format yaml --output CI.yaml --previous licenses/THIRDPARTY.yml --check-previous

# 检查命令返回值
if [ $? -ne 0 ]; then
    echo "错误：检测到许可证变更！请更新licenses/THIRDPARTY.yml文件"
    exit 1
fi

echo "许可证检查通过"

1. 在项目根目录运行：

# 首次生成许可证文件
cargo build

# 在CI中检查许可证变更
./ci_check_licenses.sh

这个完整示例展示了如何在项目构建过程中自动生成许可证文件，并在CI流程中进行验证，确保项目的许可证信息始终保持最新。