GitHub Licensed 让遵循 OSS 许可协议变得更容易

  • Sergio De Simone
  • 谢丽

2018 年 3 月 27 日

话题:开源持续集成GitHub语言 & 开发架构

看新闻很累?看技术新闻更累?试试下载 InfoQ 手机客户端,每天上下班路上听新闻,有趣还有料!

GitHub Licensed 是一款开源工具,旨在针对 GitHub 项目的所有依赖,简化许可健全性保障工作和许可文件维护工作

Licensed 可以检查一个库的多个项目里的各种语言和包管理器的依赖。其支持的包管理器包括 Bower、Bundler、Cabal、Go、Manifest lists 和 NPM。对于发现的每个依赖,Licensed 可以从他们在本地环境里的位置提取基本的元数据和相关的许可信息,如许可类型及相关的法律文本(通常保存在LICENSE文件中)。为了检测许可类型和法律文本,Licensed 使用Licensee。检查出的所有元数据都保存在一个特定的位置,如果分发的时候需要,就可以用来生成所有许可证的副本。

据 GitGHub 介绍,更重要的是,元数据和许可文本可以加入版本控制。如果你这样做了,新增的任何依赖都会反映到 PR-level 上,许可专家可以专门审核新增的许可证,检查任何应该处理的问题。根据他们自己在这个过程中得出的经验,GitHub 声称,这是一种有效的方法,可以减少和开发人员的摩擦,确保任何产品中包含的依赖都满足组织的需求。

Licensed 的运行由一个配置文件控制,你可以在其中指定需要扫描依赖项的source_path位置,保存元数据的cache_path目录以及可以使用的许可证列表。下面是一个简单的配置文件:

# 相对于 git 库根目录的路径 
# 如果不设置,则默认为“.licenses”
cache_path: 'relative/path/to/cache'

# 相对于 git 库根目录的路径,指定枚举依赖的工作目录 
source_path: 'relative/path/to/source'

# 默认情况下,允许使用遵循下列许可协议的依赖 
allowed:
  - mit
  - apache-2.0
  - bsd-2-clause
  - bsd-3-clause
  - cc0-1.0

Licensed 是一个 Ruby gem,把下面这行命令添加到 Gemfile 即可安装:

gem 'licensed', :group => 'development'

然后运行:

$ bundle

你可以通过以下命令让 Licensed 列出项目的所有依赖:

licensed list

类似地,cache命令将缓存许可证和元数据,而status命令会检查依赖的状态,并在许可证数据丢失或者许可类型需要重新审查时发出警告。

GitHub 强调,Licensed 只是一个在早期检查任何许可问题的工具,不能代替专业的法律咨询。

查看英文原文GitHub Licensed Aims to Make it Easier to Comply with OSS Licenses

开源持续集成GitHub语言 & 开发架构