Add the release branch to GitHub package repositories

This function assumes that you have admin push access to the GitHub organization indicated by org.

add_gh_release_branch(
  package_name,
  release = bioc_release_yaml(),
  gh_branch = .BIOC_DEFAULT_BRANCH,
  bioc_branch = .BIOC_DEFAULT_BRANCH,
  org = "Bioconductor"
)

add_gh_release_branches(
  packages = character(0L),
  release = bioc_release_yaml(),
  bioc_branch = .BIOC_DEFAULT_BRANCH,
  org = "Bioconductor"
)

bioc_release_yaml(config = .BIOC_CONFIG_FILE)

Arguments

package_name

character(1) The name of the organization R package that is also available on GitHub.

release

character(1) The Bioconductor version branch tag, e.g., "RELEASE_3_17"

gh_branch

character(1) The name of the default branch on GitHub. It may be 'devel' or 'main' depending on the repository

bioc_branch

character(1) The name of the default branch on the Bioconductor git server (default 'devel')

org

character(1) The organization for which to extract the names of the repositories on GitHub (default "Bioconductor").

packages

named character() A character vector of default branches whose names correspond to Bioconductor package names. See packages_without_release_branch.

config

character(1) The path to the Bioconductor configuration file that contains the release version (defaults to website URL from .BIOC_CONFIG_FILE)

See also

packages_without_release_branch

Examples

bioc_release_yaml()
#> [1] "RELEASE_3_19"
if (interactive()) {
    add_gh_release_branch(
      package_name = "BiocParallel",
      release = "RELEASE_3_19"
    )

    add_gh_release_branches(
        release = bioc_release_yaml(),
        org = "Bioconductor"
    )
}