create_tag: Create a tag in a repository

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

Description

This function creates a new tag 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_tag(name, ref, repo, ...)

Arguments

name	(string) The name of the tag.
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_tag() returns a list of the tag's properties.

Tag Properties:

• name: The name of the tag.

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

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

• zip_url: The address to download a zip file of the commit.

• tar_url: The address to download a tar file of the commit.

Examples

## Not run: 

  create_tag(
    name = "new-tag",
    ref  = "main",
    repo = "ChadGoymer/githapi"
  )


## End(Not run)

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