如何生成Github Badge徽章图标

如何生成徽章Badge

  • 什么是徽章(Badge)
  • 生成小徽章
    • shields网站
    • 开源项目的徽章
      • lib版本徽章
      • 代码测试覆盖度
      • 开源协议
      • Github workflow的徽章
    • 开源代码实践效果
      • py-enum
      • js-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?branch=master 在这里插入图片描述
其中branch表示代码分支,可以在GitHub workflows任务中添加脚本自动上报网站。

在coveralls网站生成小徽章后,也可以通过 shields 网站生成链接,例如:https://img.shields.io/coverallsCoverage/github/SkylerHu/py-enum?branch=master 效果和上面链接一样

开源协议

直接补充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?branch=master 在这里插入图片描述
其中工作流文件中定义的名称就是test for py3,如此便能显示更多的工作流执行状态了。
在这里插入图片描述

开源代码实践效果

py-enum

在这里插入图片描述

js-enumerate

在这里插入图片描述

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:/a/640204.html

如若内容造成侵权/违法违规/事实不符,请联系我们进行投诉反馈qq邮箱809451989@qq.com,一经查实,立即删除!

相关文章

ViLT学习

多模态里程碑式的文章,总结了四种多模态方法,根据文字和图像特征特征抽取方式不通。 文章的贡献主要是速度提高了,使用了数据增强,文本的mask 学习自b站朱老师的论文讲解

无线领夹麦克风哪个品牌好?无线麦克风品牌排行榜前十名推荐

​在当今的数字化浪潮中,个人声音的传播和记录变得尤为重要。无论是会议中心、教室讲台还是户外探险,无线领夹麦克风以其卓越的便携性和连接稳定性,成为了人们沟通和表达的首选工具。面对市场上琳琅满目的无线麦克风选择,为了帮助…

小程序多端框架目前所遇问题记录

一、wx.openLocation兼容 1、申请腾讯地图key 2、配置LBS SDK,选择SDK最新版本 3、调用接口,name和address必须输入,不然要报错 uni.openLocation({latitude: Number(this.info.latitude),longitude: Number(this.info.longitude),name:this…

全域外卖是谁创办的公司?

全域外卖是谁创办的公司?这个问题是抽象的。正确的问法应该是全域外卖是谁研发的系统。 在了解全域外卖系统前,我们首先要了解什么是全域外卖,什么是全域团购。全域指的是多平台。当然这个平台是越多越好。实际上也可以理解为聚合外卖、聚合…

Java 解决 古典问题

1 问题 编写一个Java程序,解决以下问题: 2 方法 再导入java.util包下的Scanner类,构建Scanner对象,以便输入。通过对问题的分析,我们可以得到,当位数为1时,其返回值为1;当位数为2时&…

电影推荐|基于SSM+vue的电影推荐系统的设计与实现(源码+数据库+文档)

电影推荐系统 目录 基于SSM+vue的电影推荐系统的设计与实现 一、前言 二、系统设计 三、系统功能设计 1系统功能模块 2管理员功能模块 四、数据库设计 五、核心代码 六、论文参考 七、最新计算机毕设选题推荐 八、源码获取: 博主介绍&#…

Flutter设计模式全面解析:单例模式

谈到设计模式这个“古老”的话题,大家先别急着划走哈,虽然对它再熟悉不过,几乎是最初开始学习编程到现在伴随着我们整个编程生涯,最早 Java、C 语言实现的各种设计模式到现在还会经常有所接触,面试中也是必问的环节&am…

IntelliJ IDEA集成Baidu Comate,商城系统支付交易功能开发实战

文章目录 Baidu Comate介绍安装配置体验安装插件配置体验注释生成代码技术问答 实战设计表生成代码导入数据 总结 Baidu Comate介绍 在科技互联网飞速发展的今天,百度凭借其深厚的技术积累和创新能力,推出了一款名为Baidu Comate智能代码助手的产品。该…

Linxu 系统中 修改 docker 镜像存放目录 修改docker默认路径。亲测有效。

1、关闭docker 服务 systemctl stop docker 2、创建新的存放路径(-p 父级目录不存在一起创建) mkdir /home/service/docker -p 3、移动默认路径中的镜像文件到新目录 mv /var/lib/docker/* /home/service/docker/ 4、修改docker.service 将新的路…

【C++】继承(二)深入理解继承:派生类默认成员函数与友元、静态成员的奥秘

目录 派生类的默认成员函数①派生类的构造函数②派生类的拷贝构造函数③派生类的赋值构造④派生类的析构函数 继承与友元继承与静态成员 前言 我们在上一章讲解了: 继承三部曲,本篇基于上次的基础继续深入了解继承的相关知识,欢迎大家和我一起学习继承 派…

微信小程序报错:notifyBLECharacteristicValueChange:fail:nodescriptor的解决办法

文章目录 一、发现问题二、分析问题二、解决问题 一、发现问题 微信小程序报错:notifyBLECharacteristicValueChange:fail:nodescriptor 二、分析问题 这个提示有点问题,应该是该Characteristic的Descriptor有问题,而不能说nodescriptor。 …

docker-file 网络

docker挂载 1.绑定挂载(Bind Mounts):绑定挂载是将主机上的文件或目录挂载到容器中。 docker run -v /host/path:/container/path image_name 2.卷挂载(Volume Mounts):卷挂载将 Docker 数据卷挂载到容器中…

Java开发大厂面试第23讲:说一下 JVM 的内存布局和运行原理?

JVM(Java Virtual Machine,Java 虚拟机)顾名思义就是用来执行 Java 程序的“虚拟主机”,实际的工作是将编译的 class 代码(字节码)翻译成底层操作系统可以运行的机器码并且进行调用执行,这也是 …

使用delphi11编写一个基于xls作为数据库的照片展示程序

1、创建xls文档可以参考前一篇博客,并使用wps将文档保存为2003格式xls后缀。 2、在form上面放置adoconnection、adotable、datasource、spinedit、timer、checkbox、image、4个button组件。 image的设置: Image1.Align : alClient; Image1.Center : Tr…

三台泵恒压供水站电控系统及PLC程序设计实例

本文由艺捷自动化编写,其旗下产品有艺捷自动化网站和易为二维码说明书小程序(微信) 本文以一个具体的项目案例,来讲述一个恒压供水站的电控柜设计过程。包括用户需求,材料选型,图纸设计,柜内布…

Manjaro linux install RedisGUI (RedisInsight)亲测2024-5-25

Arch 用户仓库(Arch User Repository)(AUR) 是用户选择 基于 Arch Linux 的系统 的一个主要理由。你可以在 AUR 中访问到大量的附加软件。 (LCTT 译注:AUR 中的 PKGBUILD 均为用户上传且未经审核,使用者需要自负责任,在构建软件包前请注意检…

ubuntu 源码安装 cloudcompare

1.系统环境: ubuntu18 cmake:3.10.2 官方安装指导:https://github.com/CloudCompare/CloudCompare/blob/master/BUILD.md (注:查看cmake版本: cmake --version) 2.安装依赖 sudo apt-get update sudo apt-get insta…

【Numpy】深入解析numpy中的ravel方法

NumPy中的ravel方法:一维化数组的艺术 🌈 欢迎莅临我的个人主页👈这里是我深耕Python编程、机器学习和自然语言处理(NLP)领域,并乐于分享知识与经验的小天地!🎇 🎓 博主简…

Linux修炼之路之自动化构建工具,进度条,gdb调试器

目录 一:自动化构建工具make/makefile 生成内容: 清理内容: 对于多过程的: 对于多次make: 特殊符号: 二:小程序之进度条 三:git的简单介绍 四:Linux调试器gdb 接…

Centos7静态路由和动态路由

路由,即路由选择(Routing),是指在计算机网络中选择数据传输路径的过程。路由器(Router)是执行路由选择功能的网络设备。路由的主要目的是在复杂的网络结构中,选择最佳路径将数据包从源节点传递到…