add badge for other module

trpc-ecosystem · Oct 24, 2023 · 189cc20 · 189cc20
1 parent cbf539f
commit 189cc20
Show file tree

Hide file tree

Showing 15 changed files with 82 additions and 2 deletions.
diff --git a/degrade/README.md b/degrade/README.md
@@ -1,5 +1,11 @@
 # tRPC-Go [degrade] 熔断保护插件
 
+[![Go Reference](https://pkg.go.dev/badge/trpc.group/trpc-go/trpc-filter/degrade.svg)](https://pkg.go.dev/trpc.group/trpc-go/trpc-filter/degrade)
+[![Go Report Card](https://goreportcard.com/badge/trpc.group/trpc-go/trpc-filter/degrade)](https://goreportcard.com/report/trpc.group/trpc-go/trpc-filter/degrade)
+[![Tests](https://github.com/trpc-ecosystem/go-filter/actions/workflows/degrade.yml/badge.svg)](https://github.com/trpc-ecosystem/go-filter/actions/workflows/degrade.yml)
+[![Coverage](https://codecov.io/gh/trpc-ecosystem/go-filter/branch/main/graph/badge.svg?flag=degrade&precision=2)](https://app.codecov.io/gh/trpc-ecosystem/go-filter/tree/main/degrade)
+
+
 ## degrade 插件使用介绍
 
 * degrade 插件主要功能：

diff --git a/filterextensions/README.md b/filterextensions/README.md
@@ -1,5 +1,10 @@
 ## tRPC-Go 拦截器扩展
 
+[![Go Reference](https://pkg.go.dev/badge/trpc.group/trpc-go/trpc-filter/filterextensions.svg)](https://pkg.go.dev/trpc.group/trpc-go/trpc-filter/filterextensions)
+[![Go Report Card](https://goreportcard.com/badge/trpc.group/trpc-go/trpc-filter/filterextensions)](https://goreportcard.com/report/trpc.group/trpc-go/trpc-filter/filterextensions)
+[![Tests](https://github.com/trpc-ecosystem/go-filter/actions/workflows/filterextensions.yml/badge.svg)](https://github.com/trpc-ecosystem/go-filter/actions/workflows/filterextensions.yml)
+[![Coverage](https://codecov.io/gh/trpc-ecosystem/go-filter/branch/main/graph/badge.svg?flag=filterextensions&precision=2)](https://app.codecov.io/gh/trpc-ecosystem/go-filter/tree/main/filterextensions)
+
 tRPC-Go 支持在 `trpc_go.yaml` 中配置拦截器，但是拦截器的精度只到 service 层，无法作更细粒度的配置，如为 method 配置拦截器。
 
 这个插件扩展了 `trpc_go.yaml` 的解析方式，以「插件」+「拦截器」的方式实现了 method 粒度的拦截器。

diff --git a/hystrix/README.md b/hystrix/README.md
@@ -1,4 +1,10 @@
 ## tRPC-Go [hystrix] fuse protection plugin
+
+[![Go Reference](https://pkg.go.dev/badge/trpc.group/trpc-go/trpc-filter/hystrix.svg)](https://pkg.go.dev/trpc.group/trpc-go/trpc-filter/hystrix)
+[![Go Report Card](https://goreportcard.com/badge/trpc.group/trpc-go/trpc-filter/hystrix)](https://goreportcard.com/report/trpc.group/trpc-go/trpc-filter/hystrix)
+[![Tests](https://github.com/trpc-ecosystem/go-filter/actions/workflows/hystrix.yml/badge.svg)](https://github.com/trpc-ecosystem/go-filter/actions/workflows/hystrix.yml)
+[![Coverage](https://codecov.io/gh/trpc-ecosystem/go-filter/branch/main/graph/badge.svg?flag=hystrix&precision=2)](https://app.codecov.io/gh/trpc-ecosystem/go-filter/tree/main/hystrix)
+
 ### hystrix plugin introduction
 
 The plugin is based on Netflix's open source hystrix component, see https://github.com/afex/hystrix-go

diff --git a/jwt/README.md b/jwt/README.md
@@ -1,5 +1,10 @@
 # tRPC-Go [jwt] 用户身份验证拦截器
 
+[![Go Reference](https://pkg.go.dev/badge/trpc.group/trpc-go/trpc-filter/jwt.svg)](https://pkg.go.dev/trpc.group/trpc-go/trpc-filter/jwt)
+[![Go Report Card](https://goreportcard.com/badge/trpc.group/trpc-go/trpc-filter/jwt)](https://goreportcard.com/report/trpc.group/trpc-go/trpc-filter/jwt)
+[![Tests](https://github.com/trpc-ecosystem/go-filter/actions/workflows/jwt.yml/badge.svg)](https://github.com/trpc-ecosystem/go-filter/actions/workflows/jwt.yml)
+[![Coverage](https://codecov.io/gh/trpc-ecosystem/go-filter/branch/main/graph/badge.svg?flag=jwt&precision=2)](https://app.codecov.io/gh/trpc-ecosystem/go-filter/tree/main/jwt)
+
 ## jwt 插件使用说明
 
 ### I. 必要条件

diff --git a/masking/README.md b/masking/README.md
@@ -1,7 +1,11 @@
 # Masking
-tRPC敏感数据脱敏模块
 
+[![Go Reference](https://pkg.go.dev/badge/trpc.group/trpc-go/trpc-filter/masking.svg)](https://pkg.go.dev/trpc.group/trpc-go/trpc-filter/masking)
+[![Go Report Card](https://goreportcard.com/badge/trpc.group/trpc-go/trpc-filter/masking)](https://goreportcard.com/report/trpc.group/trpc-go/trpc-filter/masking)
+[![Tests](https://github.com/trpc-ecosystem/go-filter/actions/workflows/masking.yml/badge.svg)](https://github.com/trpc-ecosystem/go-filter/actions/workflows/masking.yml)
+[![Coverage](https://codecov.io/gh/trpc-ecosystem/go-filter/branch/main/graph/badge.svg?flag=masking&precision=2)](https://app.codecov.io/gh/trpc-ecosystem/go-filter/tree/main/masking)
 
+tRPC敏感数据脱敏模块
 
 ## 使用说明
 

diff --git a/mock/README.md b/mock/README.md
@@ -1,5 +1,10 @@
 # mock
 
+[![Go Reference](https://pkg.go.dev/badge/trpc.group/trpc-go/trpc-filter/mock.svg)](https://pkg.go.dev/trpc.group/trpc-go/trpc-filter/mock)
+[![Go Report Card](https://goreportcard.com/badge/trpc.group/trpc-go/trpc-filter/mock)](https://goreportcard.com/report/trpc.group/trpc-go/trpc-filter/mock)
+[![Tests](https://github.com/trpc-ecosystem/go-filter/actions/workflows/mock.yml/badge.svg)](https://github.com/trpc-ecosystem/go-filter/actions/workflows/mock.yml)
+[![Coverage](https://codecov.io/gh/trpc-ecosystem/go-filter/branch/main/graph/badge.svg?flag=mock&precision=2)](https://app.codecov.io/gh/trpc-ecosystem/go-filter/tree/main/mock)
+
 It implement back-end dependency interface mock calls via interceptors.
 
 ## Instructions for use

diff --git a/recovery/README.md b/recovery/README.md
@@ -1,5 +1,10 @@
 # recovery
 
+[![Go Reference](https://pkg.go.dev/badge/trpc.group/trpc-go/trpc-filter/recovery.svg)](https://pkg.go.dev/trpc.group/trpc-go/trpc-filter/recovery)
+[![Go Report Card](https://goreportcard.com/badge/trpc.group/trpc-go/trpc-filter/recovery)](https://goreportcard.com/report/trpc.group/trpc-go/trpc-filter/recovery)
+[![Tests](https://github.com/trpc-ecosystem/go-filter/actions/workflows/recovery.yml/badge.svg)](https://github.com/trpc-ecosystem/go-filter/actions/workflows/recovery.yml)
+[![Coverage](https://codecov.io/gh/trpc-ecosystem/go-filter/branch/main/graph/badge.svg?flag=recovery&precision=2)](https://app.codecov.io/gh/trpc-ecosystem/go-filter/tree/main/recovery)
+
 Enable this plugin to capture panics at the entry point of requests and return a 500 response, preventing program crashes caused by panics.
 
 In general, this plugin should be configured as the first item in the filter configuration.

diff --git a/recovery/README.zh_CN.md b/recovery/README.zh_CN.md
@@ -1,5 +1,10 @@
 # recovery
 
+[![Go Reference](https://pkg.go.dev/badge/trpc.group/trpc-go/trpc-filter/recovery.svg)](https://pkg.go.dev/trpc.group/trpc-go/trpc-filter/recovery)
+[![Go Report Card](https://goreportcard.com/badge/trpc.group/trpc-go/trpc-filter/recovery)](https://goreportcard.com/report/trpc.group/trpc-go/trpc-filter/recovery)
+[![Tests](https://github.com/trpc-ecosystem/go-filter/actions/workflows/recovery.yml/badge.svg)](https://github.com/trpc-ecosystem/go-filter/actions/workflows/recovery.yml)
+[![Coverage](https://codecov.io/gh/trpc-ecosystem/go-filter/branch/main/graph/badge.svg?flag=recovery&precision=2)](https://app.codecov.io/gh/trpc-ecosystem/go-filter/tree/main/recovery)
+
 启用本插件后，会在请求入口处捕获panic并返回500，避免因为panic导致的程序崩溃。
 
 一般情况下，本插件应配置为filter配置中的第一项。

diff --git a/referer/README.md b/referer/README.md
@@ -1,5 +1,10 @@
 # referer
 
+[![Go Reference](https://pkg.go.dev/badge/trpc.group/trpc-go/trpc-filter/referer.svg)](https://pkg.go.dev/trpc.group/trpc-go/trpc-filter/referer)
+[![Go Report Card](https://goreportcard.com/badge/trpc.group/trpc-go/trpc-filter/referer)](https://goreportcard.com/report/trpc.group/trpc-go/trpc-filter/referer)
+[![Tests](https://github.com/trpc-ecosystem/go-filter/actions/workflows/referer.yml/badge.svg)](https://github.com/trpc-ecosystem/go-filter/actions/workflows/referer.yml)
+[![Coverage](https://codecov.io/gh/trpc-ecosystem/go-filter/branch/main/graph/badge.svg?flag=referer&precision=2)](https://app.codecov.io/gh/trpc-ecosystem/go-filter/tree/main/referer)
+
 http referer 安全验证
 
 ## 使用说明

diff --git a/slime/README.md b/slime/README.md
@@ -1,6 +1,13 @@
-English | [中文](./README_zh_CN.md)
+English | [中文](README.zh_CN.md)
 
 ## Supported Protocols
+
+[![Go Reference](https://pkg.go.dev/badge/trpc.group/trpc-go/trpc-filter/slime.svg)](https://pkg.go.dev/trpc.group/trpc-go/trpc-filter/slime)
+[![Go Report Card](https://goreportcard.com/badge/trpc.group/trpc-go/trpc-filter/slime)](https://goreportcard.com/report/trpc.group/trpc-go/trpc-filter/slime)
+[![Tests](https://github.com/trpc-ecosystem/go-filter/actions/workflows/slime.yml/badge.svg)](https://github.com/trpc-ecosystem/go-filter/actions/workflows/slime.yml)
+[![Coverage](https://codecov.io/gh/trpc-ecosystem/go-filter/branch/main/graph/badge.svg?flag=slime&precision=2)](https://app.codecov.io/gh/trpc-ecosystem/go-filter/tree/main/slime)
+
+
 <span style="color:red">**DO NOT enable retry/hedging for non-idempotent requests**</span>.  
 <span style="color:red">Not all protocols can use retry/hedging</span>.  
 Yaml config in Chapter Slime may not be suitable for non tRPC protocols. In this case, you could use the

diff --git a/slime/README.zh_CN.md b/slime/README.zh_CN.md
@@ -1,6 +1,12 @@
 [English](./README.md) | 中文
 
 ## 支持的协议
+
+[![Go Reference](https://pkg.go.dev/badge/trpc.group/trpc-go/trpc-filter/slime.svg)](https://pkg.go.dev/trpc.group/trpc-go/trpc-filter/slime)
+[![Go Report Card](https://goreportcard.com/badge/trpc.group/trpc-go/trpc-filter/slime)](https://goreportcard.com/report/trpc.group/trpc-go/trpc-filter/slime)
+[![Tests](https://github.com/trpc-ecosystem/go-filter/actions/workflows/slime.yml/badge.svg)](https://github.com/trpc-ecosystem/go-filter/actions/workflows/slime.yml)
+[![Coverage](https://codecov.io/gh/trpc-ecosystem/go-filter/branch/main/graph/badge.svg?flag=slime&precision=2)](https://app.codecov.io/gh/trpc-ecosystem/go-filter/tree/main/slime)
+
 <span style="color:red">**请不要对非幂等请求开启重试/对冲功能**</span>。
 <span style="color:red">并非所有协议都能使用重试/对冲</span>。
 对于非 trpc 协议，可能并不适用 Slime 一章的 yaml 配置，这时，你可以直接使用基础包。

diff --git a/transinfo-blocker/README.md b/transinfo-blocker/README.md
@@ -1,5 +1,11 @@
 # transinfo blocker
 
+[![Go Reference](https://pkg.go.dev/badge/trpc.group/trpc-go/trpc-filter/transinfo-blocker.svg)](https://pkg.go.dev/trpc.group/trpc-go/trpc-filter/transinfo-blocker)
+[![Go Report Card](https://goreportcard.com/badge/trpc.group/trpc-go/trpc-filter/transinfo-blocker)](https://goreportcard.com/report/trpc.group/trpc-go/trpc-filter/transinfo-blocker)
+[![Tests](https://github.com/trpc-ecosystem/go-filter/actions/workflows/transinfo-blocker.yml/badge.svg)](https://github.com/trpc-ecosystem/go-filter/actions/workflows/transinfo-blocker.yml)
+[![Coverage](https://codecov.io/gh/trpc-ecosystem/go-filter/branch/main/graph/badge.svg?flag=transinfo-blocker&precision=2)](https://app.codecov.io/gh/trpc-ecosystem/go-filter/tree/main/transinfo-blocker)
+
+
 - trpc 框架下透传字段安全插件, 用于屏蔽调用下游的字段，避免登录态及其他敏感信息泄露问题。
 
 ## 使用说明

diff --git a/tvar/README.md b/tvar/README.md
@@ -1,5 +1,10 @@
 # trpc-go tvar统计插件
 
+[![Go Reference](https://pkg.go.dev/badge/trpc.group/trpc-go/trpc-filter/tvar.svg)](https://pkg.go.dev/trpc.group/trpc-go/trpc-filter/tvar)
+[![Go Report Card](https://goreportcard.com/badge/trpc.group/trpc-go/trpc-filter/tvar)](https://goreportcard.com/report/trpc.group/trpc-go/trpc-filter/tvar)
+[![Tests](https://github.com/trpc-ecosystem/go-filter/actions/workflows/tvar.yml/badge.svg)](https://github.com/trpc-ecosystem/go-filter/actions/workflows/tvar.yml)
+[![Coverage](https://codecov.io/gh/trpc-ecosystem/go-filter/branch/main/graph/badge.svg?flag=tvar&precision=2)](https://app.codecov.io/gh/trpc-ecosystem/go-filter/tree/main/tvar)
+
 ## 插件简介
 
 实现serverside、clientside RPC等监控项的统计上报

diff --git a/validation/README.md b/validation/README.md
@@ -1,5 +1,10 @@
 # Validation
 
+[![Go Reference](https://pkg.go.dev/badge/trpc.group/trpc-go/trpc-filter/validation.svg)](https://pkg.go.dev/trpc.group/trpc-go/trpc-filter/validation)
+[![Go Report Card](https://goreportcard.com/badge/trpc.group/trpc-go/trpc-filter/validation)](https://goreportcard.com/report/trpc.group/trpc-go/trpc-filter/validation)
+[![Tests](https://github.com/trpc-ecosystem/go-filter/actions/workflows/validation.yml/badge.svg)](https://github.com/trpc-ecosystem/go-filter/actions/workflows/validation.yml)
+[![Coverage](https://codecov.io/gh/trpc-ecosystem/go-filter/branch/main/graph/badge.svg?flag=validation&precision=2)](https://app.codecov.io/gh/trpc-ecosystem/go-filter/tree/main/validation)
+
 Parameter automatic validation plugin. Supports custom error codes.
 
 ## Usage

diff --git a/validation/README.zh_CN.md b/validation/README.zh_CN.md
@@ -1,5 +1,10 @@
 # Validation
 
+[![Go Reference](https://pkg.go.dev/badge/trpc.group/trpc-go/trpc-filter/validation.svg)](https://pkg.go.dev/trpc.group/trpc-go/trpc-filter/validation)
+[![Go Report Card](https://goreportcard.com/badge/trpc.group/trpc-go/trpc-filter/validation)](https://goreportcard.com/report/trpc.group/trpc-go/trpc-filter/validation)
+[![Tests](https://github.com/trpc-ecosystem/go-filter/actions/workflows/validation.yml/badge.svg)](https://github.com/trpc-ecosystem/go-filter/actions/workflows/validation.yml)
+[![Coverage](https://codecov.io/gh/trpc-ecosystem/go-filter/branch/main/graph/badge.svg?flag=validation&precision=2)](https://app.codecov.io/gh/trpc-ecosystem/go-filter/tree/main/validation)
+
 参数自动校验插件，支持自定义错误码。
 
 ## 使用说明