如何在你的 git readme 中添加一些徽章(GitHub、Gitlab 等)
发布这个repo 的时候,我一直在寻找一些徽章添加到我的 readme 中。结果发现了一些值得分享的有趣服务。
制作徽章最棒的地方是https://shields.io。不过,我会解释如何在盾牌中使用它们。
建造
首先,你要寻找的徽章是“构建通过”徽章。你已经编写了一些很棒的测试,需要证明它们已经通过。市面上有几种不错的服务可以做到这一点,我使用了Travis CI。
集成非常简单。你只需要.travis.yml
在你的代码库中添加一个文件即可。我的操作非常简单:
language: python
python:
- "3.7"
install:
- pip install -r requirements.txt
script:
- python -m pytest --cov-report term --cov=app
after_success:
- codecov
接下来我会讲到这after_success
部分。在此之前,你需要徽章,对吧?只需点击按钮即可获得build passing
。
代码覆盖率
你已经通过了测试,并获得了徽章。现在你需要为测试添加一些覆盖率。你已经通过运行带有覆盖率选项的测试了解了这一点。对于 Python,你可以运行以下命令python -m pytest --cov-report term --cov=app
。但是如何获得徽章呢?
你可以使用Codecov。对于 Python,你需要codecov
通过 安装包pip install codecov
。然后只需在你的.travis.yml
-
after_success:
- codecov
您可以在设置页面中找到该徽章。
您也可以使用Coveralls来实现同样的目的。在这种情况下,您需要coveralls
在 Python 中安装相应的包。您可以在 Coveralls 仓库页面底部找到徽章。
依赖项监视器
这真的很有用,不仅适用于徽章,而且您还可以通过即将到来的更新来管理您的依赖关系。
对于 Python,您可以使用require.io。要获取新软件包变更的 PR,您需要按照以下步骤进行配置:Hooks -> 新建拉取请求 -> (根据需要配置)-> 保存变更。您可以在具体的仓库页面中找到徽章。
对于 Node.js 来说,Depfu是一项很棒的服务。你将自动获得 PR,无需设置任何钩子。你可以在特定 repo 页面的设置中找到徽章。
代码质量
有几种服务可以做到这一点。我用过lgtm和Code Climate。我不会比较或评判它们,因为它们都给我的评分是 A 😅
您可以在特定 repo 的集成页面中找到 lgtm 徽章,并且可以在 repo 设置页面中找到 codeclimate 徽章。
还有其他满足您特定需求的服务。其实,您可以从盾牌上了解这些服务。用它们制作徽章真的很容易。快来试试吧!
鏂囩珷鏉ユ簮锛�https://dev.to/ananto30/how-to-add-some-badges-in-your-git-readme-github-gitlab-etc-3ne9