苏州网站建设最佳方案,炫酷网站源码下载,做网站点击率赚钱,宁波做网站皆选蓉胜网络如何生成徽章Badge 什么是徽章(Badge)生成小徽章shields网站开源项目的徽章lib版本徽章代码测试覆盖度开源协议Github workflow的徽章 开源代码实践效果py-enumjs-enumerate 什么是徽章(Badge)
在开源项目的README中#xff0c;经常会见到一些徽章(Badge)小图标#xff0c;如… 如何生成徽章Badge 什么是徽章(Badge)生成小徽章shields网站开源项目的徽章lib版本徽章代码测试覆盖度开源协议Github workflow的徽章 开源代码实践效果py-enumjs-enumerate 什么是徽章(Badge)
在开源项目的README中经常会见到一些徽章(Badge)小图标如下图所示 可以看到README中这些小图标每个徽章都对应的一个URL。
本文将介绍如何生成这些小徽章。
注因博客无法展示外站图片地址所以本都还用截图展示效果后文中徽章URL可以直接点击效果。
生成小徽章
shields网站
官网地址https://shields.io/badges
该网站不仅仅可以支持对接npm/pypi等各大源站lib的信息还可以完全自定义徽章。
自定义徽章 示例https://img.shields.io/badge/any_text-you_like-blue 中间用-隔开即可自定义徽章效果如上图所示。
开源项目的徽章
开源项目中定义的徽章当然都不是通过自定义而来而是遵循社区的规范生成而来下面分别介绍
lib版本徽章代码测试覆盖度开源协议Github workflow的徽章一般可用于自动跑测试用例
ps: 所有生成方法在shields网站中均有生成的方法说明。
lib版本徽章
都是固定前缀增加开源库名称即可
Python开源库–固定前缀增加库名称即可 https://img.shields.io/pypi/v/py-enum npm开源库https://img.shields.io/npm/v/js-enumerate
代码测试覆盖度
测试覆盖度要借助 coveralls 网站了。
该网站可以使用Github账号登录对于公开的Github项目我们可以免费将测试报告上传至网站就可以在网站上看到测试报告同时可以看到我们想要的测试覆盖度小徽章。 示例https://coveralls.io/repos/github/SkylerHu/py-enum/badge.svg?branchmaster 其中branch表示代码分支可以在GitHub workflows任务中添加脚本自动上报网站。
在coveralls网站生成小徽章后也可以通过 shields 网站生成链接例如https://img.shields.io/coverallsCoverage/github/SkylerHu/py-enum?branchmaster 效果和上面链接一样
开源协议
直接补充Github仓库名称即可也还支持其他仓库例如gitlab等具体可以查看官网
https://img.shields.io/github/license/SkylerHu/py-enum
Github workflow的徽章
Github项目名称 workflows配置的文件名称 https://img.shields.io/github/actions/workflow/status/SkylerHu/py-enum/test-py3.yml 从这里看出使用shiedls生成只能看到build若是有多个workflows任务配置就无法区分开。
这种情况下GitHub自身提供了工作流状态徽章方式详见官方描述 , 他能展示出工作流定义的名称。
示例https://github.com/SkylerHu/py-enum/actions/workflows/test-py3.yml/badge.svg?branchmaster 其中工作流文件中定义的名称就是test for py3如此便能显示更多的工作流执行状态了。
开源代码实践效果
py-enum js-enumerate
