【问题标题】:How to add R-CMD-check state on README at Github如何在 Github 的 README 中添加 R-CMD-check 状态
【发布时间】:2020-07-28 18:13:30
【问题描述】:

我知道如何在 R Studio 中进行 R-CMD-check 并且全部通过了。

但是,我希望在 Github

上的包的 README 文件中添加此 R-CMD 检查“通过”状态

如下图所示。

我看到别人的这部分只是一个链接,点击它就变成了这张图片。

我想知道如何在 Github 上进行 R-CMD-check,以便在 README 中添加“通过”状态

【问题讨论】:

  • 这不是一个真正的编程问题。但是其中一部分(codecov)是通过将您的 github 页面连接到同名网站 codecov 来完成的(此处的链接描述了如何)
  • 好问题。此外,被低估了。

标签: r github package readme


【解决方案1】:

如果您想自动获得此徽章,请使用您的包打开 R 项目并运行:

usethis::use_github_action_check_standard()

在 R 控制台(或 RStudio)中。这将在您的包中添加一个包含一些 YAML 内容的 .github/workflows/ 文件夹。见documentation

当您提交并推送到 GitHub 时,检查应该会自动运行。如果要插入徽章,请转到 GitHub Web 界面中的“操作”菜单,打开检查结果,您将看到要插入到 README.md 中的徽章源代码(SVG 格式)文件。每次推送后都会更新。

如需完整且非常简单的屏幕截图手册,请访问https://ropenscilabs.github.io/actions_sandbox/packageci.html#actions-for-continuous-integration-checks

【讨论】:

  • 您好,谢谢您的帮助。但是,这是我得到的错误。 usethis::use_github_action_check_standard()Error in file(con, "r") : cannot open the connectionIn addition: Warning message:In file(con, "r") : InternetOpenUrl failed: 'The operation timed out'
  • @BocongZhao 在这种情况下,您可能没有互联网连接或 R 被阻止下载数据。因此,转到example 并将其复制到您的软件包仓库的.github/workflows/check-standard.yaml 文件中,提交、推送,然后访问“操作”菜单等。
猜你喜欢
  • 2021-02-05
  • 1970-01-01
  • 2015-07-05
  • 2012-04-28
  • 2022-08-16
  • 2021-09-24
  • 2021-06-26
  • 2023-01-24
相关资源
最近更新 更多