Skip to content

Warns user when use_pkgdown is run on non-default branch #2172

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Warns user when use_pkgdown is run on non-default branch #2172

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1f1e97f
add warning for use_pkgdown not on main fixes #2065
sierrajohnson Sep 19, 2025
4a49e30
Merged upstream/main into main
sierrajohnson Sep 19, 2025
6f25fb5
moving warning to github_pages function
sierrajohnson Sep 19, 2025
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
14 changes: 14 additions & 0 deletions R/pkgdown.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,20 @@ use_pkgdown_github_pages <- function() {
tr <- target_repo(github_get = TRUE, ok_configs = c("ours", "fork"))
check_can_push(tr = tr, "to turn on GitHub Pages")

cfg <- github_remote_config(github_get = NA)
online <- is_online(tr$host)

default_branch <- if (online) {
git_default_branch_(cfg)
} else {
guess_local_default_branch()
}
challenge_non_default_branch(
"Your site will not build until this branch is merged with
{.val {default_branch}}. Do you want to continue on this branch?",
default_branch = default_branch
)

use_pkgdown()
site <- use_github_pages()
use_github_action("pkgdown")
Expand Down
2 changes: 1 addition & 1 deletion man/usethis-package.Rd
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading