delete_milestone: Delete a milestone from a repository

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

Description

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

Usage

delete_milestone(milestone, repo, ...)

Arguments

milestone	(string or character) The number or title of the milestone.
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/issues#delete-a-milestone

Value

delete_milestone() returns a TRUE if successfully deleted.

Examples

## Not run: 

  # Delete a milestone
  delete_milestone(
    milestone = "test milestone",
    repo      = "ChadGoymer/githapi"
  )


## End(Not run)

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