吉特登

R-CMD检查 覆盖率状态 CRAN状态

{gitdown}的目标是构建提交的预订报告根据模式排列的消息。书本可以整理根据git标签，提到的问题(例如 #123)或git中包含的任何自定义字符链提交消息(例如 类别_用于类似类别用户界面,类别_文档, …).

{pkgdown}站点上的完整文档：https://thinkr-open.github.io/gitdown/index.html

安装

您可以从CRAN安装{gitdown}的稳定版本：

安装.包(“gitdown”)

您可以从GitHub安装最新版本的{gitdown}：

遥控器::安装github(“ThinkR-open/gitdown”)

创建一个版本化目录的可复制示例

在临时目录

图书馆（dplyr）
图书馆（吉特登）
##为示例创建假存储库
回购<- 假回购()

创建一个按模式排序的提交gitbook

{gitdown}的主要功能是用所有提交根据模式排序的消息。每个提交消息与问题相关联的内容将记录在此问题的部分中。因此，如果提交消息与有多个问题。
如果您有自己的外部票据参考系统软件，您还可以使用票如下例所示。

git_down（向下）（回购，图案= c（c）(“门票” = “票证[[：数字：]]+”,
                           “问题” = “#[[：数字：]]+”))

如果添加通信表，则可以更改模式。
注意，您可以使用{gitlabr}或{高}从检索问题列表分别是GitLab或GitHub，如中所示“”下载“GitLab或GitHub问题，并对您的提交“.

#带通信表
图案表<- 数据帧(
  数字= c（c）("#2","#1","#1000"),
  标题= c（c）(“#2说明博客帖子的第二期”,
            “#1问题示例”,
            “#1000问题，未提交”))
git_down（向下）(
  图案= c（c）(“问题” = “#[[：数字：]]+”),
  图案表=图案表
)

请注意，以下字符[,],_或*将被替换为-在里面避免与标记语法冲突的标题。

阅读的列表提交和提取信息

作为{gitdown}的副作用，您可以获得一些中间产物用于构建带有一些导出函数的书的信息。

获取所提及问题的提交。搜索的模式是#后跟至少一个数字：“#[[：数字：]]+”.变量模式内容列出了在提交消息中找到的模式。

获取承诺模式（回购，图案= “#[[：数字：]]+”,参考= “主要”)%>% 
  选择（模式内容，一切())
#>找到4个提交。
#>#A台：7×12
#>pattern.content sha摘要消息作者在订购时发送电子邮件
#><chr><chr>
#>1#32 8790c…添加NE…“添加NE..Alice alic…2022-03-04 15:31:14 4
#>2#1 8790c…添加NE…“添加NE..Alice alic…2022-03-04 15:31:14 4
#>3#12 8790c…添加NE…“添加NE…Alice alic…2022-03-04 15:31:14
#>4#2 c0870…第三…“第三…Alice alic…2022-03-04 15:31:14 3
#>5#145 c0870…第三…“第三…Alice alic…2022-03-04 15:31:14 3
#>6#1 a97db…exampl…“示例…Alice alic…2022-03-04 15:31:14 2
#>7<NA>b27b5…第一…“第一…Alice alic…2022-03-04 15:31:14 1
#>#…还有4个变量：tag.name<chr>、tag.message<chr]、，
#>#pattern.type＜chr＞，pattern.title＜chr＞

获得对问题和特定自制模式的承诺。使用命名的向量来正确地分隔模式类型。

获取承诺模式(
回购，
  图案=  c（c）(“门票” = “票证[[：数字：]]+”,“问题” = “#[[：数字：]]+”),
  参考= “主要”
)%>% 
  选择（pattern.type、pattern.content、，一切())
#>找到4个提交。
#>#A桥：12×12
#>pattern.type pattern.content sha摘要消息作者电子邮件
#><chr><chr><chr
#>1票证票证6789 8790cc60…Add NEWS“添加新闻\n\n…Alice Alice…
#>2张票证1234 8790cc60…Add NEWS“添加新闻\n\n…Alice Alice…
#>3问题#32 8790cc60…添加新闻“添加新闻\n\n…Alice Alice…
#>4问题#1 8790cc60…添加新闻“添加新闻\n\n…Alice Alice…
#>5期#12 8790cc60…添加新闻“添加新闻\n\n…Alice Alice…
#>6票<NA>c0870ab4…第三次…“第三次提交…Alice Alice…
#>7问题#2 c0870ab4…第三公司…“第三次提交…Alice Alice…
#>8问题#145 c0870ab4…第三公司…“第三次提交…Alice Alice…
#>9门票票1234a97db45b…示例：…“示例：mod…Alice Alice…
#>10问题#1 a97db45b…示例：…“示例：mod…Alice Alice…
#>11票<NA>b27b55fe…First co.…“第一次提交…Alice Alice…
#>12个问题<NA>b27b55fe…First co.…“First commit…Alice Alice…
#>#…还有5个变量：when<dttm>，order<int>，tag.name<chr>，
#>#标记消息<chr>，pattern.title<chr>

创建列出所有文件及修改日期的小插曲

回购_千克<- 伪造报告(as.包装= 真的)
#仅列出R/目录中的文件
创建_vignette_last_modif（回购_千克）
#列出git存储库的所有文件
创建_活动_最后_修改（回购_千克，路径= "")

通过此示例，小插曲将显示以下内容：

文件 以git跟踪 创建日期 上次修改时间
新闻.md 是的 2022-03-04 16:31:14 2022-03-04 16:31:14
示例.txt 是的 2022-03-04 16:31:14 2022-03-04 16:31:14
R/my平均值。R（右） 不 不适用 2022-03-04 16:31:14

该软件包的开发由以下各方赞助：

行为准则

请注意，{gitdown}项目是用贡献者行为准则。通过参与此项目，您同意遵守根据其条款。