dev/create_testor_on_gitlab.R

pkgload::load_all()

# From here, you should already have followed step 1-4 in CONTRIBUTING.md

# Load environment variables
if (file.exists(here::here("dev/environment.yml"))) {
  do.call(
    Sys.setenv,
    yaml::yaml.load_file(here::here("dev/environment.yml"))
  )
}

# Set connection
set_gitlab_connection(
  gitlab_url = "https://gitlab.com",
  private_token = Sys.getenv("GITLABR_TEST_TOKEN")
)

# Create all projects for CI or local
# Projects with name containing "master" will have default branch named "master", "main" otherwise
# CI only - to allow run in parallel
projects_names <- c(
  "testor.macos", "testor.windows", "testor.release",
  "testor.devel", "testor.release.master", "testor.coverage"
)
# Local - Only the first one is mandatory
projects_names <- "testor.main"

# Store all outputs
all_outputs <- list()

for (test_project_name in projects_names) {
  # Define main branch
  if (grepl("master", test_project_name)) {
    gitlabr_options_set("gitlabr.main", "master")
  } else {
    gitlabr_options_set("gitlabr.main", "main")
  }
  main_branch <- get_main()

  # 5. Create a project called `testor`, owned by the user
  project_info <- gl_new_project(
    name = test_project_name,
    default_branch = main_branch,
    initialize_with_readme = TRUE
  )

  # Verify branches (depending on GitLab, main branch may still be "master")
  all_branches <- gl_list_branches(project = project_info$id)
  if (main_branch == "main" && all_branches$name == "master") {
    message("Change from master to main for tests")

    gl_create_branch(project = project_info$id, branch = "main", ref = "master")
    gl_edit_project(project = project_info$id, default_branch = "main") # Change default_branch = "main"
    gl_delete_branch(project = project_info$id, branch = "master")
    # Verify
    project_info <- gl_get_project(test_project)
    testthat::expect_equal(project_info$default_branch, "main")
  } else if (main_branch == "master" && all_branches$name == "main") {
    message("Change from main to master for tests")

    gl_create_branch(project = project_info$id, branch = "master", ref = "main")
    gl_edit_project(project = project_info$id, default_branch = "master") # Change default_branch = "main"
    gl_delete_branch(project = project_info$id, branch = "main")
    # Verify
    project_info <- gl_get_project(test_project)
    testthat::expect_equal(project_info$default_branch, "master")
  }

  # browseURL(project_info$web_url)

  # 6. Get the ID of the project
  # This will be presented at the end of this script
  # message("Add variable in your dev/environment.yml: GITLABR_TEST_PROJECT_NAME: ", project_info$name)
  # message("Add variable in your dev/environment.yml: GITLABR_TEST_PROJECT_ID: ", project_info$id)

  # 7. Add/modify and commit the `README.md`:
  content_md <- paste("
# testor

Repository to test R package ['gitlabr'](https://github.com/ThinkR-open/gitlabr)
")

  gl_push_file(
    project = project_info$id,
    file_path = "README.md",
    content = content_md,
    commit_message = "Update README",
    branch = main_branch,
    overwrite = TRUE
  )

  # 8. Go to Repository > Branches and create a branch named "for-tests".
  gl_create_branch(project = project_info$id, branch = "for-tests", ref = main_branch)
  # gl_list_branches(project = project_info$id)

  # 9. Add and commit a CI file (`.gitlab-ci.yml`)
  content_ci <- paste("
testing:
  script: echo 'test 1 2 1 2' > 'test.txt'
  artifacts:
    paths:
      - test.txt
")

  gl_push_file(
    project = project_info$id,
    file_path = ".gitlab-ci.yml",
    content = content_ci,
    commit_message = "Add CI to the main branch",
    branch = main_branch,
    overwrite = TRUE
  )

  # 10. Create a commit (or use the commit just created), add a follow-up comment
  commits_in_main <- gl_get_commits(project = project_info$id, ref_name = main_branch)
  gl_comment_commit(
    project = project_info$id,
    id = commits_in_main$id[1],
    text = "Write a comment"
  )

  # This will be presented at the end of this script
  # message("Add variable in dev/environment.yml: COMMENTED_COMMIT: ", comment_infos = commits_in_main$id[1])

  # 11. Create a first issue (#1) with a follow-up comment
  issue_info <- gl_create_issue(project = project_info$id, title = "Dont close issue 1", description = "An example issue to not close for tests")
  gl_comment_issue(project = project_info$id, id = issue_info$iid, text = "A comment on issue to not close")

  # Remind environment variables to add in "dev/environment.yml"
  message("Add variable in your dev/environment.yml: GITLABR_TEST_PROJECT_NAME: ", project_info$name)
  message("Add variable in your dev/environment.yml: GITLABR_TEST_PROJECT_ID: ", project_info$id)
  message("Add variable in your dev/environment.yml: COMMENTED_COMMIT: ", commits_in_main$id[1])

  all_outputs[[test_project_name]] <-
    list(
      ci.matrix = glue::glue(
        "projectname: '{project_info$name}', projectid: '{project_info$id}', comcommit: '{commits_in_main$id[1]}'"
      ),
      local.env = glue::glue(
        "GITLABR_TEST_PROJECT_NAME: {project_info$name}
        GITLABR_TEST_PROJECT_ID: {project_info$id}
        COMMENTED_COMMIT: {commits_in_main$id[1]}"
      )
    )
  # Unset connection
  unset_gitlab_connection()
}

# ci.matrix is for CI in .github workflows
# local.env is to fill "dev/environment.yml"
print(purrr::transpose(all_outputs))

# For local tests, you will not be able to test on both repo in the same loop.
# You can comment environment variables when needed
# Also, only content of sub-list "local.env" is required

# Create extra projects just to be sure there is something to test ----
# This is to get some R styled projects so that we can test GitLab CI

# Set connection
set_gitlab_connection(
  gitlab_url = "https://gitlab.com",
  private_token = Sys.getenv("GITLABR_TEST_TOKEN")
)

source(here::here("dev/testor_tools.R"))

gitlabr_options_set("gitlabr.main", "main")
# _ R package
project_name <- "demo.package"
project_info <- gl_new_project(
  name = project_name,
  default_branch = "main",
  initialize_with_readme = TRUE
)
# Create tmp dir
tmpdir <- tempfile(pattern = "pkg-")
dir.create(tmpdir)
project_path <- file.path(tmpdir, project_name)

# Clone in tmp dir
clone_locally(
  project_name = project_info$path,
  group_url = project_info$namespace.web_url,
  project_path = project_path,
  open = TRUE
)

usethis::with_project(project_path, {
  usethis::create_package(path = project_path, open = FALSE)
  attachment::att_amend_desc()
})

push_to_repo(project_path, message = "Init repo")


# _ bookdown
project_name <- "demo.bookdown"
project_info <- gl_new_project(
  name = project_name,
  default_branch = "main",
  initialize_with_readme = TRUE
)
# Create tmp dir
tmpdir <- tempfile(pattern = "pkg-")
dir.create(tmpdir)
project_path <- file.path(tmpdir, project_name)

# Clone in tmp dir
clone_locally(
  project_name = project_info$path,
  group_url = project_info$namespace.web_url,
  project_path = project_path,
  open = TRUE
)

file.copy(
  list.files(
    system.file("rstudio", "templates", "project", "resources", package = "bookdown"),
    all.files = TRUE, full.names = TRUE, recursive = TRUE
  ),
  to = project_path,
  recursive = TRUE
)
# Add CI
gitlabr::use_gitlab_ci(
  path = file.path(project_path, ".gitlab-ci.yml"),
  type = "bookdown"
)

push_to_repo(project_path, message = "Init repo")

# _ bookdown production
# _ R package with 'renv'
statnmap/gitlabr documentation built on May 19, 2024, 12:22 p.m.