Lock and unlock branch as part of the release process #2145
+89
−5
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This ensures that there's no way to accidentally forget that you're in the middle of the release process and make a change to the repo. Part of #1946
DavisVaughan
approved these changes
Jul 29, 2025
Comment on lines
+302
to
+305
| #' These functions lock and unlock a branch on GitHub so that it's not possible | ||
| #' for anyone to make any changes. This is used as part of the release process | ||
| #' to ensure that you don't accidentally merge any pull requests or push any | ||
| #' commits while you are waiting for CRAN to get back to you. |
There was a problem hiding this comment.
Anything about permissions required to perform this action?
| #' | ||
| #' @export | ||
| #' @param branch The branch to lock/unlock. If not supplied, uses the | ||
| #' default branch with is usually "main" or "master". |
There was a problem hiding this comment.
Suggested change
| #' default branch with is usually "main" or "master". | |
| #' default branch which is usually "main" or "master". |
| repo <- target_repo(cfg) | ||
| branch <- branch %||% git_default_branch_(cfg) | ||
|
|
||
| invisible(gh::gh( |
There was a problem hiding this comment.
What happens if you lock an already locked branch?
| @@ -137,13 +138,15 @@ release_checklist <- function(version, on_cran, target_repo = NULL) { | |||
| "", | |||
| "Submit to CRAN:", | |||
| "", | |||
| todo("`usethis::gh_lock_branch()"), | |||
There was a problem hiding this comment.
Suggested change
| todo("`usethis::gh_lock_branch()"), | |
| todo("`usethis::gh_lock_branch()`"), |
| todo("`usethis::use_version('{type}')`"), | ||
| todo("`devtools::submit_cran()`"), | ||
| todo("Approve email"), | ||
| "", | ||
| "Wait for CRAN...", | ||
| "", | ||
| todo("Accepted :tada:"), | ||
| todo("`usethis::gh_unlock_branch()"), |
There was a problem hiding this comment.
Suggested change
| todo("`usethis::gh_unlock_branch()"), | |
| todo("`usethis::gh_unlock_branch()`"), |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This ensures that there's no way to accidentally forget that you're in the middle of the release process and make a change to the repo.
Part of #1946
@DavisVaughan it's been a long time since we discussed this, but does this make sense to you?
@jennybc mostly opening to start discussion; not planning to merge just yet.