delete_project: Delete a GitHub project

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

Description

This function deletes a project in GitHub. Care should be taken as it will not be recoverable. If you just want to close the project use update_project().

Usage

delete_project(project, repo, user, team, org, ...)

Arguments

project	(integer or string) Either the project number or name.
repo	(string, optional) The repository specified in the format: owner/repo.
user	(string, optional) The login of the user.
team	(string or integer, optional) The team ID or name.
org	(string, optional) The name of the organization.
...	Parameters passed to gh_request().

Details

You can delete a project associated with either a repository, user, team or organization, by supplying them as an input, as long as you have appropriate permissions. Deleting a team project just removes the team's access. If you want to delete it completely you have to delete the organization's project.

For more details see the GitHub API documentation:

• https://docs.github.com/en/rest/reference/projects#delete-a-project

• https://docs.github.com/en/rest/reference/teams#remove-a-project-from-a-team

Value

delete_project() returns a TRUE if successfully deleted.

Examples

## Not run: 

  # Delete a project for a repository
  delete_project(
    project = "Repo project",
    repo    = "ChadGoymer/githapi"
  )

  # Delete a project for a user
  delete_project(
    project = "User project",
    user    = "ChadGoymer"
  )

  # Remove a team's access to the organization's project
  delete_project(
    project = "User project",
    team    = "HeadCoos",
    org     = "HairyCoos"
  )

  # Delete a project for an organization
  delete_project(
    project = "User project",
    org     = "HairyCoos"
  )


## End(Not run)

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