create_column: Create a column in a GitHub project

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

Description

This function creates a new column in a project in GitHub. The column will be empty so you will need to add cards separately.

Usage

create_column(name, project, repo, user, org, ...)

Arguments

name	(string) The name of the column.
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.
org	(string, optional) The name of the organization.
...	Parameters passed to gh_request().

Details

You can create a column in a project associated with either a repository, user or organization, by supplying them as an input, as long as you have appropriate permissions.

For more details see the GitHub API documentation:

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

Value

create_column() returns a list of the column properties.

Column Properties:

• id: The ID of the column.

• name: The name given to the column.

• created_at: When it was created.

• updated_at: When it was last updated.

Examples

## Not run: 

  # Create a column in a repository project
  create_column(
    name    = "Test column",
    project = "Test project",
    repo    = "ChadGoymer/githapi"
  )

  # Create a column in a user's project
  create_column(
    name    = "Test column",
    project = "Test project",
    user    = "ChadGoymer"
  )

  # Create a column in an organization's project
  create_column(
    name    = "Test column",
    project = "Test project",
    org     = "HairyCoos"
  )


## End(Not run)

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