徽章的含意 當你瀏覽一個開源項目時,看到各" />

国产成人精品无码青草_亚洲国产美女精品久久久久∴_欧美人与鲁交大毛片免费_国产果冻豆传媒麻婆精东

15158846557 或 在線咨詢 在線咨詢
15158846557 或 在線咨詢
所在位置： 首頁 > 營銷資訊 > 網(wǎng)站運營 > GitHub 徽章制作

GitHub 徽章制作

時間：2023-06-24 16:36:02 | 來源：網(wǎng)站運營

時間：2023-06-24 16:36:02 來源：網(wǎng)站運營

GitHub 徽章制作：
很早前寫過一篇關于Golang持續(xù)集成服務之Travis教程, 今天再寫寫關于 github 上常見的徽章是如何制作的. 讓你的開源項目更高大上, 讓你的代碼也更健壯.

徽章的含意

當你瀏覽一個開源項目時,看到各種徽章, 有些徽章是直接反應這個開源庫的質(zhì)量和完整性等等.






如上圖所示

  1. 第一個徽章即 Github 自帶的 workflow 提供的持續(xù)集成(CI)和持續(xù)部署(CD), 官方稱之為 Actions, 圖示顯示為 CI, CD 是否通過
  2. 第二個徽章即 Codecov 是一個測試結(jié)果分析工具, 圖標顯示測試覆蓋率.
  3. 第三個徽章即 shields.io 一個可以自定義徽章的網(wǎng)站
  4. 第四個徽章即 goreportcard 是一個項目綜合評分網(wǎng)站
  5. 第五個徽章即 gitter 自定義討論組的網(wǎng)站

CI&CD 徽章

github 于2018. 10月推薦 GitHub Actions 持續(xù)集成服務, 在此之前大家都是使用 https://travis-ci.org/ 持續(xù)集成服務, 之前我也寫過相關文章. Golang持續(xù)集成服務之Travis教程.
持續(xù)集成和持續(xù)部署目前 github 官方自帶支持, 官方稱之為 GitHub Actions.

只要你在 github 上創(chuàng)建一個開源項目倉庫就自帶 Actions 功能, 支持各種語言. 還可以自動發(fā)布 GitHub Pages 等功能, 十分強大.

如何使用可以參考阮一峰寫的GitHub Actions 入門教程

關于GO的持續(xù)集成服務模板參考:

使用 GitHub Actions 后會在你的項目里自帶生成一個.github文件夾, 即.github/workflows/go.yml
name: Go # 使用語言on: # 監(jiān)聽動作 push: # 監(jiān)聽 push 動作 branches: [ main ] # 監(jiān)聽哪個分支 branch pull_request: branches: [ main ]jobs: # 工作 job build: # 構(gòu)建動作 runs-on: ubuntu-latest # 基于 ubuntu 系統(tǒng) steps: - uses: actions/checkout@v2 - name: Set up Go uses: actions/setup-go@v2 with: go-version: 1.15 - name: Build # 構(gòu)建項目 run: go build -v ./... - name: Test # 運行用例 run: go test -v .徽章的制作.

https://github.com/yezihack/e/workflows/Go/badge.svg
  1. https://github.com/yezihack/e 是項目的地址
  2. workflows/Go/badge.svg 中間的Go 是 https://github.com/yezihack/e/actions?query=workflow%3AGo 下的名稱. 需要注意區(qū)分大小寫

測試覆蓋率 徽章

登陸官網(wǎng) https://codecov.io/ 使用 GitHub 帳號登陸, 授權導出你的項目.

在項目的根目錄新建.travis.yml 文件

實例文件參考

language: go # 使用語言.go: - 1.15.6 # 版本號, 支持多種版本號sudo: required # #有定制化開發(fā)環(huán)境需要，默認false，不開啟容器，編譯效率高 os: # 使用的操作系統(tǒng) - linux - osxnotifications: # 郵箱通知 email: freeit@126.comgo_import_path: # 使用Go需要導入的包. - github.com/gin-gonic/gin - github.com/pkg/errors - github.com/smartystreets/goconveybefore_install: # 主要安裝一些系統(tǒng)依賴, - go mod tidyinstall: true # 安裝, true跳過script: # 腳本執(zhí)行. - echo "run" - go test -race -coverprofile=coverage.txt -covermode=atomic - go test -v ./...after_success: # 上傳測試報告 - bash <(curl -s https://codecov.io/bash)徽章制作

點擊Settings -> Badge







文檔徽章

https://pkg.go.dev/ 只針對Golang語言自動生成文檔
打開網(wǎng)站直接輸入你項目的訪問地址, 自帶生成.

如 https://github.com/yezihack/e

文檔地址即: https://pkg.go.dev/github.com/yezihack/e

徽章制作

https://img.shields.io/badge/go.dev-reference-brightgreen?logo=go&logoColor=white&style=flat[![Go doc](https://img.shields.io/badge/go.dev-reference-brightgreen?logo=go&logoColor=white&style=flat)](https://pkg.go.dev/github.com/yezihack/e)

綜合報告徽章

打開 https://goreportcard.com/ 直接填寫你的項目訪問地址即可.







徽章制作

https://goreportcard.com/badge/github.com/yezihack/e

討論組徽章

打開 https://gitter.im/ 注冊, 創(chuàng)建一個小組, 可以邀請開發(fā)者一起討論.

創(chuàng)建小組時最好以你的用戶名+倉庫名 命名. 這樣方便識別.

徽章制作

獲取你的討論組的地址, 然后在 https://shields.io/category/chat 選擇 Gitter即可. 填寫你的用戶名和倉庫名信息

![Gitter](https://img.shields.io/gitter/room/yezihack/e)

其它徽章

打開 https://shields.io 可以自定義很多個性的圖標, 讓你的項目更專業(yè).












關鍵詞：徽章

74
73
25
news

版權所有? 億企邦 1997-2025 保留一切法律許可權利。

為了最佳展示效果，本站不支持IE9及以下版本的瀏覽器，建議您使用谷歌Chrome瀏覽器。 點擊下載Chrome瀏覽器
關閉