delete_releases: Delete releases.

Description Usage Arguments Details Value

View source: R/repositories-releases.R

Description

This function deletes the specified releases. It also deletes the tags associated with the releases from the repository.

Usage

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

Arguments

tags

(character) The tag names associated with the releases.

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/repos/releases/#delete-a-release

Value

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


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