update_column: Update a column in a GitHub project

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

Description

update_column() can be used to change the column name in a project in GitHub. move_column() can be used to reorder the columns.

Usage

update_column(column, name, project, repo, user, org, ...)

move_column(column, position, after, project, repo, user, org, ...)

Arguments

column	(integer or string) Either the column number or name.
name	(string, optional) The new name for 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().
position	(string, optional) Either "first" or "last".
after	(integer or string, optional) An ID or name of another column to place this one after.

Details

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

You can move a column by either specifying the position, either "first" or "last", or by specifying another column to place it after.

For more details see the GitHub API documentation:

• https://docs.github.com/en/rest/reference/projects#update-an-existing-project-column

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

Value

update_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: 

  # Update the name of a column in a repository project
  update_column(
    column  = "Test column",
    name    = "Updated test column",
    project = "Test project",
    repo    = "ChadGoymer/githapi"
  )

  # Move a column to the first position in a user's project
  move_column(
    name     = "Test column",
    position = "first",
    user     = "ChadGoymer"
  )

  # Move a column after another on in an organization's project
  move_column(
    name  = "Test column",
    after = "Test column 2",
    org   = "HairyCoos"
  )


## End(Not run)

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