我正在使用AnyBadge https://github.com/jongracecox/anybadge 与 GitHub 操作。 但我找不到在 README 上显示徽章的方法,也找不到此存储库中编写的任何文档。
我尝试将其保存在 Artifacts 中。但是,它是一个 zip 文件并且没有 url,所以我不知道如何在 README 上显示它。
谢谢!
注意:我们的仓库是私人(组织)
https://github.com/anuraghazra/github-readme-stats 您可以检查这一点,只需在 readme.MD 文件中复制一些命令,该文件基本上是一种特殊类型的存储库,我们用来仅显示此类介绍和详细信息。
有一个名为 anybadge-action 的 GitHub 操作,由 knightdave 创建,可以帮助解决此问题。
有几个项目实施了此操作,因此您可以遵循他们的方法。
在这个示例中,我们可以看到创建通过/失败徽章的操作,然后是一个将徽章写入 GitHub Pages 的发布操作:
- name: Generate passing badge
if: success()
uses: knightdave/[email protected]
with:
file: docs/_badges/lint.svg
label: lint
value: passing
color: green
template: docs/_badges/template.svg
overwrite: true
- name: Generate failing badge
if: failure()
uses: knightdave/[email protected]
with:
file: docs/_badges/lint.svg
label: lint
value: failing
color: red
template: docs/_badges/template.svg
overwrite: true
- name: Publish badge
if: success() || failure()
uses: JamesIves/github-pages-deploy-action@v4
with:
branch: gh-pages
folder: docs/_badges
target-folder: _badges
clean: false
在项目README.md中我们可以看到markdown图片和链接,格式为
[![alt-text](badge-link)](target-url)
:
[![Lint status](https://bagherilab.github.io/arcade-collection/_badges/lint.svg)](https://github.com/bagherilab/arcade-collection/actions?query=workflow%3Alint)
此方法可以适用于将值从工作流变量(例如 lint 分数)传递到 anybade 操作。