什么是github中的构建和传递按钮?

时间:2018-04-30 04:44:26

标签: github

enter image description here

我猜那些与项目部署工具有关的东西。实际上那些是什么,如何添加这些以及它们的好处是什么?

编辑1
是否有任何结算问题(付款)与那些或那些是免费的?

3 个答案:

答案 0 :(得分:2)

它们被称为Code Repository Badges,并详细说明了存储库一般稳定性的各个方面。有许多徽章,但最常见的是:

  • build: passing:表示项目的测试全部通过。这通常通过 Travis-CI 集成来设置。
  • coverage:测试了多少项目。图片中代码75%已通过单元测试。
  • dependenices:存储库在其他存储库上有多少依赖项运行
  • devDependencies:存储库在其他存储库上有多少依赖项,以便开发

答案 1 :(得分:0)

他们是什么

这些是“徽章”。各种构建工具,包管理器等提供徽章。

假设您正在使用AppVeyor进行持续集成和部署,在AppVeyor的项目设置中,它们提供了一个HTML / markdown片段,您可以将其嵌入GitHub这样的地方,以显示每个人都在查看您的GitHub自述文件的最后一次构建那是成功的。

徽章通常(但不总是)是动态的,因为服务提供商(npm,AppVeyor等)将从URL(在您获得的代码段中)提供徽章,并且当客户端抓取该图像时它将显示徽章数据的最新状态(构建成功/失败,在npm上可用,测试失败,代码覆盖率%等)。

如何使用

您可以从服务提供商那里获得代码片段(npm,AppVeyor等),然后将其直接粘贴到您的自述文件或任何您喜欢的地方。

有什么好处

根据徽章的显示情况,这会有很大的不同,但有些例子可能是:

  • 构建状态徽章:告诉您是否可以构建当前分支中的最新代码。有助于快速向人们展示WIP或代码库的问题。
  • 代码覆盖率徽章:告诉您单元测试所涵盖的代码百分比。如果您遇到GitHub仓库并想知道代码库的质量和单元测试覆盖率(如果这对您很重要),则非常有用。
  • 测试传递徽章:传递/失败的测试数量。与构建失败状态类似,您可以快速了解此库的潜在消费者,或者甚至作为Houston, we have a problem的团队开发人员。
  • NPM徽章:版本徽章,可用,下载次数等都是人们有用的信息指示。
  • 混杂。静态徽章:某些服务/图书馆提供的徽章只是静态徽章,通常用于图书馆/品牌/服务的促销目的。框架X可能会创建带有徽标/名称的徽章,喜欢它的开发人员可以通过将徽章放在自己的自述文件中来说明他们的网站/框架依赖于/使用框架X.
  • 可能性是无穷无尽的。

答案 2 :(得分:0)

这些称为代码存储库徽章

引用an online resource

  

作为热衷于编写优秀代码的人,我们会展示"徽章"在我们的代码存储库中向开发人员发出信号,我们为自己编写的代码设定了高标准,将其视为牛仔裤或其他可靠产品上的软件等同物。

简而言之,这是一种说法,嘿,看,我的GitHub项目有很高的标准!"。上面的链接实际上是关于不同徽章的一些细节,但是让我指出你的图片中显示的两个常见的:

  1. "建立传球"
  2. 这使用了像Travis CI这样的持续集成工具,当您将代码推送到GitHub存储库时,这将有助于构建和测试代码(假设您已为该存储库设置了Travis CI)。

    使用此功能可以确保不会将任何重大更改合并到您的项目中,还可以防止浪费审阅者'拉动请求的时间和精力不是"工作"。

    1. "覆盖"
    2. 这可以衡量GitHub项目中实际测试的代码量。它使用Codecov之类的工具,再次以你为你的存储库设置了这样的工具为前提。

      使用它可以提醒贡献者为代码编写正确的测试,以便可以检测到代码中的任何潜在错误。

      正如您所看到的,徽章有助于确保您的项目保持一定的标准,这可以提高您的项目质量,甚至吸引人们参与您的项目(例如,在GitHub上托管的开源软件) )。