There are multiple breaking changes in {gitlabr} v2, please refer to the corresponding vignette: https://statnmap.github.io/gitlabr/articles/z-gitlabr-v2.html

Note that the {gitlabr} package was originally created by Jirka Lewandowski. The present repository is a fork to be able to continue development of this package.

Installation

You can install the most recent stable version from CRAN using:

install.packages("gitlabr")

To install the development version using devtools, type:

devtools::install_github("statnmap/gitlabr")

See the CONTRIBUTING.md for instructions on how to run tests locally and contributor information.

Quick Start Example

R code using {gitlabr} to perform some common GitLab actions can look like this

  • Create a TOKEN on your GitLab instance with scopes: api
    • For instance on gitlab.com: https://gitlab.com/-/profile/personal_access_tokens
  • Store your token in .Renviron as GITLAB_COM_TOKEN with usethis::edit_r_environ() and restart your session
  • Set a connection to GitLab instance
library(gitlabr)

# You can verify your token works
# Sys.getenv("GITLAB_COM_TOKEN")

# connect as a fixed user to a GitLab instance for the session
set_gitlab_connection(
  gitlab_url = "https://gitlab.com",
  private_token = Sys.getenv("GITLAB_COM_TOKEN"))
  • Find the list of projects available to you
    • Define a limit of pages of projects to search in with max_page, otherwise the entire GitLab.com will be downloaded here…
    • Find all parameters available in the API for projects on this page: https://docs.gitlab.com/ee/api/projects.html
      • For instance, we can set owned = FALSE to retrieve all projects except ours.
# a tibble is returned, as is always by {gitlabr} functions
gl_list_projects(max_page = 2, owned = FALSE) 
#> # A tibble: 40 x 127
#>    id     description  name   name_with_names… path  path_with_names… created_at
#>    <chr>  <chr>        <chr>  <chr>            <chr> <chr>            <chr>     
#>  1 28734… "C64 musics… 8bit_… gryken / 8bit_m… 8bit… gryken2017/8bit… 2021-08-0…
#>  2 28734… ""           yomay… Hekka / yomayod… yoma… helencloudell/y… 2021-08-0…
#>  3 28734… "role for d… r_doc… kh_ansible_role… r_do… kh_ansible_role… 2021-08-0…
#>  4 28734…  <NA>        Gimov… Gimovers / Gimo… gimo… g480/gimovers    2021-08-0…
#>  5 28734… ""           Hotel  Gokkul A / Hotel hotel Gokkul23/hotel   2021-08-0…
#>  6 28734… ""           NotIm… mwoolf-verifica… noti… mwoolf-verifica… 2021-08-0…
#>  7 28734… ""           Dohoa… Trưởng Nguyễn Đ… doho… nguyenductruong… 2021-08-0…
#>  8 28734… ""           test   Maksym Snizhyns… test  maxim.snezhinsk… 2021-08-0…
#>  9 28734…  <NA>        Filde… Fildena 100 mg … fild… fildena-1001/fi… 2021-08-0…
#> 10 28734… ""           Fulls… Yomna BATCH / F… full… YomnaBATCH/full… 2021-08-0…
#> # … with 30 more rows, and 120 more variables: default_branch <chr>,
#> #   ssh_url_to_repo <chr>, http_url_to_repo <chr>, web_url <chr>,
#> #   readme_url <chr>, forks_count <chr>, star_count <chr>,
#> #   last_activity_at <chr>, namespace.id <chr>, namespace.name <chr>,
#> #   namespace.path <chr>, namespace.kind <chr>, namespace.full_path <chr>,
#> #   namespace.avatar_url <chr>, namespace.web_url <chr>,
#> #   container_registry_image_prefix <chr>, _links.self <chr>,
#> #   _links.issues <chr>, _links.merge_requests <chr>,
#> #   _links.repo_branches <chr>, _links.labels <chr>, _links.events <chr>,
#> #   _links.members <chr>, packages_enabled <chr>, empty_repo <chr>,
#> #   archived <chr>, visibility <chr>, owner.id <chr>, owner.name <chr>,
#> #   owner.username <chr>, owner.state <chr>, owner.avatar_url <chr>,
#> #   owner.web_url <chr>, resolve_outdated_diff_discussions <chr>,
#> #   container_expiration_policy.cadence <chr>,
#> #   container_expiration_policy.enabled <chr>,
#> #   container_expiration_policy.keep_n <chr>,
#> #   container_expiration_policy.older_than <chr>,
#> #   container_expiration_policy.name_regex <chr>,
#> #   container_expiration_policy.next_run_at <chr>, issues_enabled <chr>,
#> #   merge_requests_enabled <chr>, wiki_enabled <chr>, jobs_enabled <chr>,
#> #   snippets_enabled <chr>, container_registry_enabled <chr>,
#> #   service_desk_enabled <chr>, service_desk_address <chr>,
#> #   can_create_merge_request_in <chr>, issues_access_level <chr>,
#> #   repository_access_level <chr>, merge_requests_access_level <chr>,
#> #   forking_access_level <chr>, wiki_access_level <chr>,
#> #   builds_access_level <chr>, snippets_access_level <chr>,
#> #   pages_access_level <chr>, operations_access_level <chr>,
#> #   analytics_access_level <chr>, container_registry_access_level <chr>,
#> #   shared_runners_enabled <chr>, lfs_enabled <chr>, creator_id <chr>,
#> #   import_status <chr>, open_issues_count <chr>, ci_default_git_depth <chr>,
#> #   ci_forward_deployment_enabled <chr>, ci_job_token_scope_enabled <chr>,
#> #   public_jobs <chr>, build_timeout <chr>,
#> #   auto_cancel_pending_pipelines <chr>, ci_config_path <chr>,
#> #   only_allow_merge_if_pipeline_succeeds <chr>,
#> #   restrict_user_defined_variables <chr>, request_access_enabled <chr>,
#> #   only_allow_merge_if_all_discussions_are_resolved <chr>,
#> #   remove_source_branch_after_merge <chr>,
#> #   printing_merge_request_link_enabled <chr>, merge_method <chr>,
#> #   squash_option <chr>, auto_devops_enabled <chr>,
#> #   auto_devops_deploy_strategy <chr>, autoclose_referenced_issues <chr>,
#> #   keep_latest_artifact <chr>, approvals_before_merge <chr>, mirror <chr>,
#> #   external_authorization_classification_label <chr>,
#> #   requirements_enabled <chr>, security_and_compliance_enabled <chr>,
#> #   merge_pipelines_enabled <chr>, merge_trains_enabled <chr>,
#> #   namespace.parent_id <chr>, emails_disabled <chr>,
#> #   forked_from_project.id <chr>, forked_from_project.description <chr>,
#> #   forked_from_project.name <chr>,
#> #   forked_from_project.name_with_namespace <chr>,
#> #   forked_from_project.path <chr>,
#> #   forked_from_project.path_with_namespace <chr>,
#> #   forked_from_project.created_at <chr>, …

Work with a specific project

  • Explore one of your projects. You can set the name of the project or its ID. The ID is highly recommended, in particular if your project does not appear in the first pages of projects above.
my_project <- 20384533 #repo.rtask",
gitlabr_options_set("gitlabr.main", "master")
gl_list_files(project = my_project)
#> # A tibble: 2 x 5
#>   id                                       name        type  path        mode  
#>   <chr>                                    <chr>       <chr> <chr>       <chr> 
#> 1 9c66eff9a1f6f34b6d9108ef07d76f8ce4c4e47f NEWS.md     blob  NEWS.md     100644
#> 2 c36b681bb31b80cbd090f07c95f09788c88629a6 example.txt blob  example.txt 100644
gl_list_issues(project = my_project)
#> # A tibble: 2 x 35
#>   id    iid   project_id title description state created_at updated_at author.id
#>   <chr> <chr> <chr>      <chr> <chr>       <chr> <chr>      <chr>      <chr>    
#> 1 6952… 2     20384533   A se… The blog p… open… 2020-08-0… 2020-08-0… 4809823  
#> 2 6952… 1     20384533   An e… No desc in… open… 2020-08-0… 2020-08-0… 4809823  
#> # … with 26 more variables: author.name <chr>, author.username <chr>,
#> #   author.state <chr>, author.avatar_url <chr>, author.web_url <chr>,
#> #   type <chr>, user_notes_count <chr>, merge_requests_count <chr>,
#> #   upvotes <chr>, downvotes <chr>, confidential <chr>, issue_type <chr>,
#> #   web_url <chr>, time_stats.time_estimate <chr>,
#> #   time_stats.total_time_spent <chr>, task_completion_status.count <chr>,
#> #   task_completion_status.completed_count <chr>, blocking_issues_count <chr>,
#> #   has_tasks <chr>, _links.self <chr>, _links.notes <chr>,
#> #   _links.award_emoji <chr>, _links.project <chr>, references.short <chr>,
#> #   references.relative <chr>, references.full <chr>
  • Create an issue
# create a new issue
new_feature_issue <- gl_create_issue(project = my_project, title = "Implement new feature")

# statnmap user ID
my_id <- 4809823

# assign issue to me
gl_assign_issue(project = my_project,
                issue_id = new_feature_issue$iid,
                assignee_id = my_id)

# Verify new issue is here
gl_list_issues(project = my_project, state = "opened")

# close issue
gl_close_issue(project = my_project, issue_id = new_feature_issue$iid)$state

Note that recent version of GitLab may have anti-spam on opening issues, leading to ERROR with gl_create_issue() if you abuse the API. You will need to open the issue manually in this case.

Use additional requests

If an API request is not already available in {gitlabr}, function gitlab() allows to use any request of the GitLab API https://docs.gitlab.com/ce/api/.

For instance, the API documentation shows how to create a new project in https://docs.gitlab.com/ce/api/projects.html#create-project:

  • The verb is POST
  • The request is projects
  • Required attributes are name or path (if name not set)
  • default_branch is an attribute that can be set if wanted, but not required

The corresponding use of gitlab() is:

gitlab(
  req = "projects",
  verb = httr::POST,
  name = "toto",
  default_branch = "main"
)

Implement whatever suits your needs !

Unset connection

Using GitLab CI with {gitlabr}

{gitlabr} can also be used to create a .gitlab-ci.yml file to test, build and check an R package, a bookdown, … using GitLab’s CI software. Use gitlabr::use_gitlab_ci() with a specific type in your project and your CI should be ready to start in the next commit.

There are pre-defined templates:

  • bookdown-production.yml

  • bookdown.yml

  • check-coverage-pkgdown-renv.yml

  • check-coverage-pkgdown.yml

Further information

  • For an introduction see the vignette("quick-start-guide-to-gitlabr")
  • When writing custom extensions (“convenience functions”) for {gitlabr} or when you experience any trouble, the very extensive GitLab API documentation can be helpful.

Contributing to {gitlabr}

You’re welcome to contribute to {gitlabr} by editing the source code, adding more convenience functions, filing issues, etc. CONTRIBUTING.md compiles some information helpful in that process.

Code of Conduct

Please note that the gitlabr project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.