delete_branches: Delete branches.

Description Usage Arguments Details Value

View source: R/git-branches-deprecated.R

Description

This function deletes the specified branches from a repository in GitHub.

Usage

1
2
3
4
5
6
7
delete_branches(
  branches,
  repo,
  token = getOption("github.token"),
  api = getOption("github.api"),
  ...
)

Arguments

branches

(character) The branch names.

repo

(string) The repository specified in the format: owner/repo.

token

(string, optional) The personal access token for GitHub authorisation. Default: value stored in the environment variable GITHUB_TOKEN (or GITHUB_PAT) or in the R option "github.token".

api

(string, optional) The URL of GitHub's API. Default: the value stored in the environment variable GITHUB_API or in the R option "github.api".

...

Parameters passed to gh_request().

Details

https://developer.github.com/v3/git/refs/#delete-a-reference

Value

A named list containing TRUE if the branch was deleted. An error is thrown otherwise.


ChadGoymer/githapi documentation built on March 28, 2020, 11:36 p.m.