create_branch: Create a branch in a repository

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

Description

This function creates a new branch in the specified repository in GitHub. It must be pointed at a commit by providing a Git reference, which can be either a SHA, branch or tag. For a branch, the head commit is used.

Usage

create_branch(name, ref, repo, ...)

Arguments

name	(string) The name of the branch.
ref	(string) Either a SHA, branch or tag used to identify the commit.
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#create-a-reference

Value

create_branch() returns a list of the branch's properties.

Branch Properties:

• name: The name of the branch.

• sha: The commit SHA the branch is pointing at.

• protected: Whether the branch is protected.

• html_url: The address of the branch's web page in GitHub.

Examples

## Not run: 

  create_branch(
    name = "new-branch",
    ref  = "main",
    repo = "ChadGoymer/githapi"
  )


## End(Not run)

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