create_issue: Create an issue in a repository

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

Description

This function creates a new issue for the specified repository in GitHub. It can also be used to assign the issue to a user and add labels or a milestone.

Usage

create_issue(title, repo, body, assignees, labels, milestone, ...)

Arguments

title	(string) The title of the issue.
repo	(string) The repository specified in the format: owner/repo.
body	(string, optional) The contents of the issue.
assignees	(character, optional) Logins for Users to assign to this issue. NOTE: Only users with push access can set assignees for new issues.
labels	(character, optional) Labels to associate with this issue. NOTE: Only users with push access can set labels for new issues.
milestone	(character or integer, optional) The title or number of the milestone to associate this issue with. NOTE: Only users with push access can set the milestone for new issues.
...	Parameters passed to gh_request().

Details

For more details see the GitHub API documentation:

• https://docs.github.com/en/rest/reference/issues#create-an-issue

Value

create_issue() returns a list of the issue's properties.

Issue Properties:

• number: The number assigned to the issue.

• title: The title of the issue.

• body: The body contents of the issue.

• assignees: The users assigned to the issue.

• labels: The labels attached to the issue.

• milestone: The milestone assigned to the issue.

• state: The state of the issue - either "open" or "closed".

• repository: The repository the issue is in.

• pull_request: Whether the issue is a pull request.

• html_url: The URL of the issue's web page in GitHub.

• creator: The creator's login.

• created_at: When the issue was created.

• updated_at: When the issue was last updated.

• closed_at: When the issue was closed.

Examples

## Not run: 

  create_issue(
    title     = "user issue",
    repo      = "ChadGoymer/test-issues",
    body      = "This is an issue to test create_issue()",
    assignees = "ChadGoymer",
    labels    = "feature",
    milestone = "release-1.0"
  )

  create_issue(
    title     = "organization issue",
    repo      = "HairyCoos/test-issues",
    body      = "This is an issue to test create_issue()",
    assignees = "ChadGoymer"
  )


## End(Not run)

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