Lock and unlock branch as part of the release process #2145
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -296,3 +296,52 @@ scold_for_scopes <- function(scopes) { | |
| ) | ||
| ui_bullets(message) | ||
| } | ||
|
|
||
| #' Lock and unlock a branch on GitHub | ||
| #' | ||
| #' @description | ||
| #' 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. | ||
|
Comment on lines
+303
to
+306
There was a problem hiding this comment. Anything about permissions required to perform this action? There was a problem hiding this comment. You need to be an admin or owner, which I've documented. It looks like this is already in line with our governance tidyup where the maintainer has admin access: https://github.com/tidyverse/tidyups/blob/main/004-governance.md#maintainer. |
||
| #' | ||
| #' You must be an admin or an owner of the repo in order to lock/unlock | ||
| #' a branch. | ||
| #' | ||
| #' @export | ||
| #' @param branch The branch to lock/unlock. If not supplied, uses the | ||
| #' default branch which is usually "main" or "master". | ||
| gh_lock_branch <- function(branch = NULL) { | ||
| cfg <- github_remote_config(github_get = TRUE) | ||
| repo <- target_repo(cfg) | ||
|
There was a problem hiding this comment. Right around here we could adapt this code we use in Lines 38 to 47 in 0592077 There was a problem hiding this comment. I think it's probably fine to let the GitHub error bubble up, and then we can add more user-friendly errors if we discover it's causing substantial confusion. |
||
| 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? There was a problem hiding this comment. Looks like it's idempotent |
||
| "PUT /repos/{owner}/{repo}/branches/{branch}/protection", | ||
| owner = repo$repo_owner, | ||
| repo = repo$repo_name, | ||
|
Comment on lines
+321
to
+322
There was a problem hiding this comment. We usually do a different move to create these |
||
| branch = branch, | ||
| # required parameters | ||
| required_status_checks = NA, | ||
| enforce_admins = TRUE, | ||
| required_pull_request_reviews = NA, | ||
| restrictions = NA, | ||
| # paramter that actually does what we want | ||
| lock_branch = TRUE | ||
| )) | ||
| } | ||
|
|
||
| #' @export | ||
| #' @rdname gh_lock_branch | ||
| gh_unlock_branch <- function(branch = NULL) { | ||
| cfg <- github_remote_config(github_get = TRUE) | ||
| repo <- target_repo(cfg) | ||
| branch <- branch %||% git_default_branch_(cfg) | ||
|
|
||
| invisible(gh::gh( | ||
| "DELETE /repos/{owner}/{repo}/branches/{branch}/protection", | ||
| owner = repo$repo_owner, | ||
| repo = repo$repo_name, | ||
| branch = branch | ||
| )) | ||
| } | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What do we think of
github_lock_branch()? Just want us to at least consider. I don't have a strong opinion.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't have a strong opinion either. If you want user-facing functions to use a
github_prefix I'm happy to change it.