{gitlabr}快速入门指南

快速入门示例

要运行此vignette中的代码，您需要拥有GitLab帐户您需要生成个人访问令牌（PAT）。查看GitLab文档如何生成PAT。在范围只有你一部分需要勾选应用程序编程接口框。

R代码使用{gitlabr}执行一些简单、常见的GitLab操作可以如下所示：

图书馆（吉特拉布）

#将令牌存储在中。Renviron并重新启动会话
用这个::编辑___environ()
#添加：GITLAB_COM_TOKEN=您的令牌
#你可以验证它是否有效
系统.getenv(“GITLAB_COM_TOKEN”)

#以固定用户身份连接到GitLab实例
设置gitlab_connection(
  gitlab_url= "https://about.gitlab.com/",
  private_token（私人标记）= 系统.getenv(“GITLAB_COM_TOKEN”)
)

gl_list_项目(第页= 1)#返回GitLab上的所有项目，因此我们仅限于结果的第一页。

#您不太可能想使用{gitlabr}与GitLab上的所有项目交互，因此更好的方法是定义您要处理的项目。这可以通过在GitLab.com上查找项目ID来完成（它列在repo首页上项目名称的正下方）。
#这里我们使用[项目“repo.rtask”](https://gitlab.com/statnmap/repo.rtask)
我的项目（_P）<- 20384533
gl列表文件(项目=我的项目）

#创建新问题
新特性发布<- gl_创建_发布(标题= “实现新功能”,
                                  项目=我的项目）

#statnmap用户ID
我的id<- 4809823

#将问题分配给我
gl_分配_发布(分配者id=示例用户$身份证件，
                问题id=新特性发布$iid、，
                项目=我的项目）

#列出打开的问题
gl列表问题(状态= “已打开”,
               项目=我的项目）

#解决问题
gl_关闭_问题(问题id=新功能发布$iid中，
               项目=我的项目）$状态

｛gitlabr｝的中心功能

设置连接并浏览GitLab实例

这是使用{gitlabr}的推荐方法。为了避免重复规范gitlab_con（）在参数中样式，还可以设置由{gitlabr}管理的全局变量，以使用每次通话的特定连接功能：

设置gitlab_connection（我的gitlab）
gl_创建_发布(项目=my_项目，“实现新功能”)

gl_创建_发布（）是这里的一个示例函数原理适用于{gitlabr}的所有便利函数，从gl_*（）

请注意，集合样式并不仅仅是功能性的，因为set_gitlab_connection（）更改保存的全局变量影响所有未来的结果gitlab（）电话。你可以使用将此变量重置为默认值unset_gitlab_connection（）.

参数样式

所有便利包装器都接受一个参数gitlab_con（）指定用于实际API调用的函数。因此，您可以传递GitLab连接（由返回gl_连接（）)使用R函数调用：

我的gitlab（_G）<- gl_连接(
  gitlab_url= "https://about.gitlab.com/",
  private_token（私人标记）= 系统.getenv(“GITLAB_COM_TOKEN”))

gl_创建_发布(“实现新功能”,项目=我的项目，吉特拉布孔=我的gitlab）

再一次，gl_创建_发布（）这里是一个示例函数，primary样式适用于{gitlabr}的所有便利函数在中列出“便利功能列表“或一节中描述的用户定义函数“编写自定义GitLab请求功能”.

将GitLab CI与{gitlabr}一起使用

{gitlabr}还可以用于创建.gitlab-ci.yml公司使用GitLab的CI软件测试、构建和检查R包。请参阅使用gitlab_ci（）和的相关功能文档。