Skip to content

Set gh-pages as default branch of new repo created by animint2pages #138

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Faye-yufan wants to merge 12 commits into from
Closed

Set gh-pages as default branch of new repo created by animint2pages #138

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
0372d1c
Set gh-pages as default branch
Faye-yufan Jun 28, 2024
ea18373
`repo` = local repo, `gh_repo` = github remote
Faye-yufan Jun 28, 2024
d9782a9
Add test for default branch
Faye-yufan Jun 28, 2024
7778b1e
update test - check head file after clone
Faye-yufan Jul 2, 2024
a33e5b0
update test, use `gert::git_branch`
Faye-yufan Jul 6, 2024
f3021bd
Change default branch to gh-pages in inital commit
Faye-yufan Jul 9, 2024
23aa2bb
just checking the owner name in gh actions
Faye-yufan Jul 9, 2024
48e61a4
TO BE REVERTED - test gh env
Faye-yufan Jul 10, 2024
f4b9e55
try clone the test repo under animint org
Faye-yufan Jul 10, 2024
9076ebe
try hard-coded username
Faye-yufan Jul 10, 2024
a3516e6
Use a new test repo cuz the previous one has `main` as the default br…
Faye-yufan Jul 10, 2024
f98f9d9
Merge branch 'master' into 134-animint2pages-default-branch
tdhock Aug 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 12 additions & 5 deletions R/z_pages.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
#' viz,
#' github_repo = "my_animint2_plots",
#' commit_message = "New animint",
#' private = TRUE)
#' private = FALSE)
#' }
#'
#' @export
Expand Down Expand Up @@ -89,7 +89,7 @@ animint2pages <- function(plot.list, github_repo, commit_message = "Commit from
initial_commit(local_clone, repo, viz_url)
}
# Handle gh-pages branch
manage_gh_pages(repo, to_post, local_clone, commit_message)
manage_gh_pages(repo, owner, to_post, local_clone, commit_message, github_repo)
message(sprintf(
"Visualization will be available at %s\nDeployment via GitHub Pages may take a few minutes...", viz_url))
viz_owner_repo
Expand Down Expand Up @@ -119,7 +119,7 @@ initial_commit <- function(local_clone, repo, viz_url) {
gert::git_push(repo = repo, remote = "origin", set_upstream = TRUE)
}

manage_gh_pages <- function(repo, to_post, local_clone, commit_message) {
manage_gh_pages <- function(repo, owner, to_post, local_clone, commit_message, gh_repo_name) {
branches <- gert::git_branch_list(local = TRUE, repo = repo)
if (!"gh-pages" %in% branches$name) {
gert::git_branch_create(repo = repo, branch = "gh-pages")
Expand All @@ -129,12 +129,19 @@ manage_gh_pages <- function(repo, to_post, local_clone, commit_message) {
gert::git_add(files = ".", repo = repo)
gert::git_commit(message = commit_message, repo = repo)
gert::git_push(remote = "origin", set_upstream = TRUE, repo = repo, force = TRUE)
# Set 'gh-pages' as the default branch on GitHub using GitHub API
gh::gh(
"PATCH /repos/{owner}/{repo}",
owner = owner,
repo = gh_repo_name,
default_branch = "gh-pages"
)
}

check_no_github_repo <- function(owner, repo) {
check_no_github_repo <- function(owner, gh_repo) {
tryCatch(
{
gh::gh("/repos/{owner}/{repo}", owner = owner, repo = repo)
gh::gh("/repos/{owner}/{repo}", owner = owner, repo = gh_repo)
TRUE
},
"http_error_404" = function(err) FALSE
Expand Down
14 changes: 14 additions & 0 deletions tests/testthat/test-compiler-ghpages.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,3 +45,17 @@ test_that("animint2pages raises an error if no GitHub token is present", {
do.call(Sys.setenv, as.list(env.old))
file.copy(config.old, config.file, overwrite = TRUE)
})

test_that("animint2pages() default branch is gh-pages", {
whoami <- suppressMessages(gh::gh_whoami())
owner <- whoami[["login"]]
test_default_branch <- function(owner, repo_name) {
repo_info <- gh::gh(
"GET /repos/:owner/:repo",
owner = owner,
repo = repo_name
)
repo_info$default_branch == "gh-pages"
Copy link
Copy Markdown
Collaborator

@tdhock tdhock Jun 28, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this looks like a good start. Thanks.
however, I think a better test would be if you clone the repo and test if branch name of the clone is gh-pages ... That test would more directly address the usability concern (user would not have to switch branches) can you please change?

Copy link
Copy Markdown
Contributor Author

@Faye-yufan Faye-yufan Jun 28, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great idea! I will do that.

}
expect_true(test_default_branch(owner, "animint2pages_test_repo"))
})