如何生成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

在这里插入图片描述

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

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

FastCopy

目录 背景: 简介: 原理: 下载地址: 工具的使用: 背景: 简介: FastCopy是一款速度非常快的拷贝软件,软件版本为5.7.1 Fastcopy是日本的最快的文件拷贝工具,磁盘间相互拷贝文件是司空见惯的事情,通常情况…

redis--redis Cluster

简介 解决了redis单机写入的瓶颈问题,即单机的redis写入性能受限于单机的内存大小、并发数量、网卡速率等因素无中心架构的redis cluster机制,在无中心的redis集群当中,其每个节点保存当前节点数据和整个集群状态,每个节点都和其他所有节点连…

【MySQL精通之路】InnoDB-INFORMATION_SCHEMA库Metrics表

1.介绍 INNODB_METRICS表提供了有关INNODB性能和资源相关计数器的信息。 INNODB_METRICS表列如下所示。 有关列描述,请参阅“INFORMATION_SCHEMA库INNODB_METRICS表”。 【MySQL精通之路】INFORMATION_SCHEMA库-INNODB_METRICS表-CSDN博客 mysql> SELECT * FRO…

好书推荐|MATLAB科技绘图与数据分析

提升你的数据洞察力,用于精确绘图和分析的高级MATLAB技术 MATLAB科技绘图与数据分析——jd 本书内容 《MATLAB科技绘图与数据分析》结合作者多年的数据分析与科研绘图经验,详细讲解MATLAB在科技图表制作与数据分析中的使用方法与技巧。全书分为3部分&a…

C语言 数组——数组的定义和初始化

目录 为什么使用数组(Array)? 一维数组的定义 一维数组的初始化 一维数组元素的访问 一维数组元素的赋值 数组的逻辑存储结构 数组的物理存储结构 二维数组的定义和初始化 为什么使用数组(Array)? 一维数组的定义 一维 数组的定义 int a[10]; 定义一个有 10 个 int 型元素的…

云WAF在应对新型网络攻击中的作用是什么?

云WAF(Web Application Firewall)在应对新型网络攻击中扮演着至关重要的角色。以下是云WAF的主要作用: 实时防御与智能分析 云WAF能够实时监测并分析网络流量,一旦发现潜在攻击行为立即进行阻断,有效防止各类Web应用层…

构建传统企业信息化数字化智能化技术架构:挑战与机遇

随着数字化和智能化技术的快速发展,传统企业在信息化转型过程中面临着前所未有的机遇和挑战。如何构建适应企业需求的信息化数字化智能化技术架构,成为企业发展的关键之一。本文将探讨传统企业信息化数字化智能化技术架构的设计与实践。 一、数字化转型的…

【缺失的第一个正数】leetcode,python

真是越做越觉得自己所学尚浅,, 啊??????? 直接上石山代码:(过不了一点)。。。。。 class Solution:def firstMissingPositive(self…

SpringBoot发送邮箱

一、导入依赖 <dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-mail</artifactId> </dependency> 二、添加配置 application.yml文件 将username修改为自己的邮箱&#xff0c;password修改为…

SQL——DDL之数据表的操作

基础 # 每一列都要指定对应的类型 # 字符串&#xff1a;varchar(N) # 整数&#xff1a;int # 小数&#xff1a;double # 年月日&#xff1a;date # 年月日时分秒&#xff1a;datetime# 创建表 create table if not exists db_bigdata.student(stuid varchar(10),stuname varch…

[集群聊天服务器]----(四)MySQL数据库模块

上一节我们对网络模块和业务模块进行了解耦[集群聊天服务器]----(三)ChatService模块&#xff0c;解耦网络模块和业务模块&#xff0c;封装了回调函数。在项目中需要使用mysql数据库进行存储用户重要数据&#xff0c;并进行增删改查操作。&#xff0c;所以这一节我们对mysql的封…

Linux基础入门和帮助-第二篇

马哥教育 Linux SRE 学习笔记 用户登录信息查看命令 whoami: 显示当前登录有效用户 [rootrocky8 ~]$whoami rootwho: 系统当前所有的登录会话 [rootrocky8 ~]$who root pts/0 2024-05-24 12:55 (10.0.0.1)w: 系统当前所有的登录会话及所做的操作 [rootrocky8 ~]…

python对矩阵列进行操作

在Python中&#xff0c;可以使用NumPy库来对矩阵&#xff08;或称为矩阵、数组&#xff09;的列进行各种操作。以下是一些常见的列操作及其示例代码&#xff1a; import pandas as pd# 读取CSV文件 df pd.read_csv(output_file.csv, delimiter )# 对列进行求和 sum_columns …

WordPress 发布了独立的 SQLite 插件

之前 WordPress 在官方的 Performance Lab 插件实现 SQLite 模块&#xff0c;现在重构 SQLite 的实现&#xff0c;并且将其发布成一个独立的插件&#xff1a;SQLite Database Integration。 独立 SQLite 插件 最初的功能模块实现是基于 aaemnnosttv 的 wp-sqlite-db 插件修改实…

用ssh做跳板用周转服务器帮我们加速下载

假设有一台机器A&#xff0c;它从网站B下载东西很慢&#xff0c;但是有一台机器C&#xff0c;它从B下载比较快&#xff0c;它和A之间的速度也比较快&#xff0c;那么就可以在A发指令&#xff0c;通过ssh做跳板从C加速下载网站B的文件。 以下为示例命令&#xff1a; ssh 用户名…

【DevOps】Linux 下安装配置 Apache 服务器:打造你的专属 Web 平台

目录 一、准备工作 二、安装 Apache 三、启动和管理 Apache 四、验证安装 五、配置 Apache 5.1 修改网站根目录 5.2 配置虚拟主机 5.2.1 创建虚拟主机配置文件 5.2.2 创建网站目录 5.2.3 启用虚拟主机 5.2.4 重启 Apache 5.3 配置 HTTPS 5.3.1 安装 SSL 证书 5.3…

使用CyberRT写第一个代码, test ok

简介 计算框架是自动驾驶系统中的重中之重,也是整个系统得以高效稳定运行的基础。为了实时地完成感知、决策和执行,系统需要一系列的模块相互紧密配合,高效地执行任务流。由于各种原因,这些模块可能位于不同进程,也可能位于不同机器。这就要求计算框架中具有灵活的、高性…

谷歌蜘蛛池是什么?

或称为谷歌爬虫池&#xff0c;是一项专门针对谷歌搜索引擎优化&#xff08;SEO&#xff09;的先进技术&#xff0c;这种技术的主要目的是通过建立庞大的网站群体和复杂的链接结构来吸引和维持谷歌的爬虫程序的注意力&#xff0c;其核心是通过这种结构优化&#xff0c;增强特定网…

大学计算机专业三天看完《Python背记手册》全彩版,轻松学会 Python不迷路!

Python作为一门编程语言&#xff0c;Python提供了高效的高级数据结构&#xff0c;还能简单有效地面向对象编程。Python语法和动态类型&#xff0c;以及解释型语言的本质&#xff0c;使它成为多数平台上写脚本和快速开发应用的编程语言&#xff0c;随着版本的不断更新和语言新功…

Java | Leetcode Java题解之第109题有序链表转换二叉搜索树

题目&#xff1a; 题解&#xff1a; class Solution {ListNode globalHead;public TreeNode sortedListToBST(ListNode head) {globalHead head;int length getLength(head);return buildTree(0, length - 1);}public int getLength(ListNode head) {int ret 0;while (head…