delete_repository: Delete a user or organization repository

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

Description

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

Usage

delete_repository(repo, ...)

Arguments

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

Value

delete_repository() returns a TRUE if successfully deleted.

Examples

## Not run: 

  # Delete a user's repository
  delete_repository("ChadGoymer/user-repository")

  # Delete an organization's repository
  delete_repository("HairyCoos/org-repository")


## End(Not run)

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