delete_branch: Delete a branch from a repository

In ChadGoymer/githapi: User-friendly access to the GitHub API for R

Description

This function deletes a branch from a repository, as long as you have appropriate permissions. Care should be taken as it will not be recoverable.

Usage

delete_branch(branch, repo, ...)

Arguments

branch	(string) The name of the branch.
repo	(string) The repository specified in the format: owner/repo.
...	Parameters passed to gh_request().

Details

For more details see the GitHub API documentation:

• https://docs.github.com/en/rest/reference/git#delete-a-reference

Value

delete_branch() returns a TRUE if successfully deleted.

Examples

## Not run: 

  delete_branch(branch = "new-branch", repo = "ChadGoymer/githapi")


## End(Not run)

ChadGoymer/githapi documentation built on Oct. 22, 2021, 10:56 a.m.