开发人员帮助
许可对于开发人员来说应该很容易。我们提供了几种工具和服务,让您能够专注于编码。
内容:辅助工具,示例存储库,重用API,CI/CD工作流
这个REUSE辅助工具协助实现并确认再使用合规性。它下载完整的许可证文本,将版权和许可证信息添加到文件头中,并包含一个短片来识别问题。最终,您可以生成软件物料清单。
阅读文档以了解有关该工具的更多信息。您还会发现常见问题解答中的工具部分回答最紧迫的问题。
示例存储库
符合REUSE标准的项目是什么样的?以下存储库是基本的,但每个存储库都与REUSE兼容。我们将其用于演示REUSE在实践中的工作原理。
考虑将您的项目注册到重用API以包括动态合规徽章。
美国石油学会
这个重用API帮助您持续检查和显示是否符合REUSE准则。您可以在README文件中包含指示活动状态的标记,并使用生成的JSON文件解析输出。
这就是REUSE兼容项目的徽章外观。您可以点击徽章查看更多信息:![REUSE状态](https://api.reuse.software/badge/git.fsfe.org/reuse/api)
对于那些希望证明其存储库在提供许可和版权信息方面遵循最佳实践的人来说,API是一个完美的工具。它允许第三方服务集成实时REUSE状态,并为不想安装REUSE辅助工具进行第一次快速检查。
与REUSE中的其他内容一样,API公开可用在自由软件许可下。
预提交挂钩
您可以自动运行重复使用皮棉
在每次提交时作为Git的预提交挂钩。这使用预先提交一旦你安装好了吗,将此添加到.预提交配置.yaml
在存储库中:
回购:
- 回购: https://github.com/fsfe/reuse工具
转速: 1.0.0版
挂钩:
-身份证件: 重新使用
然后运行预提交安装
现在,每次你承诺,重复使用棉绒
是在后台运行的,如果出现错误,将阻止您进行提交。
包含在CI/CD工作流中
可以轻松地将REUSE集成到现有CI/CD流程中,以连续测试存储库及其更改是否符合REUSE要求。
FSFE提供了一个Docker映像,可用于许多CI解决方案。以下是几个示例:
无人机
在您的无人机.yml
文件:
步骤:-名称:重用图像:fsfe/reuse:最新
有关无人机的更多信息无人机.io.
github
GitHub用户可以在其工作流中集成REUSE操作。访问动作的市场页面以获取使用说明。
有关GitHub操作的详细信息帮助.github.com.
GitLab公司
在您的.gitlab-ci.yml公司
文件:
重新使用:图像:名称:fsfe/reuse:最新入口点:[“”]脚本:-重复使用棉绒
有关上GitLab CI的更多信息docs.gitlab.com网站.
特拉维斯CI
在您的.travis.yml文件
文件:
语言:最小服务:-码头工人安装前(_install):-docker-pull-fsfe/重用:最新-docker run-v${TRAVIS_BUILD_DIR}:/data fsfe/reuse:最新lint
有关Travis CI的更多信息travis-ci.com网站.