Update a GitHub issue | New Relic Documentation

Updates an existing issue in a GitHub repository (title, body, state, assignees, labels, and milestone).

For authentication setup, see GitHub issue actions.

The following inputs are available for this action.

Input	Type	Description	Example
token	String	Required. GitHub Personal Access Token (fine-grained or classic) stored as a secret. Fine-grained PATs require Issues: Read and write permission. Classic PATs require repo scope.	`"${{ :secrets:github-PAT-token }}"`
owner	String	Required. The account owner of the repository (user or organization login). Case-insensitive.	`"octocat"`
repo	String	Required. Repository name without the .git suffix. Case-insensitive.	`"Hello-World"`
issueNumber	Int	Required. The number that identifies the issue.	`1347`
title	String	Optional. The title of the issue.	`"Updated issue title"`
body	String	Optional. Issue body in GitHub-flavored Markdown. Omitted from the request if empty.	`"Updated description."`
state	String	Optional. Issue state. Use to close or reopen an issue. Allowed values: `open`, `closed`.	`"closed"`
state_reason	String	Optional. The reason for the state change. The API ignores this field unless you change `state`. Allowed values: `completed`, `not_planned`, `duplicate`, `reopened`, `null`.	`"completed"`
duplicate_issue_id	Int	Optional. The ID of the issue to mark as the canonical duplicate. Only used when `state_reason` is `duplicate`. The issue must exist and be accessible to the authenticated user.	`1200`
assignees	List	Optional. GitHub usernames to assign. Requires push access on the token. The GitHub API silently drops users without push access.	`["octocat"]`
labels	List	Optional. Labels to attach. Requires push access on the token. The API auto-creates unknown labels if you have permission. Otherwise, the API rejects them.	`["resolved", "p1"]`
milestone	Int	Optional. The milestone number (integer ID, not the title). Requires push access on the token. The milestone must already exist in the repository.	`3`
type	String	Optional. The name of the issue type to associate with this issue (for example, Bug, Task, Feature). Requires push access. Issue types must be configured at the repository or organization level before use.	`"Bug"`
issueFieldValues	List	Optional. Issue field values for GitHub Projects v2 custom fields. Each object must include `field_id` (integer) and `value` (string, number, or array for multi-select fields). Only available for organization-owned repositories with GitHub Projects v2 custom fields enabled.	`[{"field_id": 1, "value": "high"}]`
selectors	List	Optional. JQ selectors to extract values from the response.	`[{"name": "issueState", "expression": ".state"}]`

This action returns the following outputs.

Output	Type	Example
response	Object	`{ "id": 1, "number": 1347, "state": "closed", "state_reason": "completed", "title": "Found a bug", "html_url": "https://github.com/octocat/Hello-World/issues/1347", "body": "I'm having a problem with this.", "created_at": "2011-04-22T13:33:48Z", "updated_at": "2011-04-22T13:33:48Z" }`
success	Boolean	`success: true \| false`
errorMessage	String	Contains the GitHub API error response body.

Output

Type

Example

response

Object

{
  "id": 1,
  "number": 1347,
  "state": "closed",
  "state_reason": "completed",
  "title": "Found a bug",
  "html_url": "https://github.com/octocat/Hello-World/issues/1347",
  "body": "I'm having a problem with this.",
  "created_at": "2011-04-22T13:33:48Z",
  "updated_at": "2011-04-22T13:33:48Z"
}

success

Boolean

success: true | false

errorMessage

String

Contains the GitHub API error response body.

Workflow example
`name: github_update_issue_workflow description: Update a GitHub issue steps: - name: update_issue type: action action: gitHub.issue.update version: 1 inputs: token: ${{ :secrets:github-PAT-token }} owner: your_user_name repo: test-workflow issueNumber: 7 title: Issue has been resolved body: Investigation complete. Closing this issue. state: closed state_reason: completed labels: - resolved next: end`

Workflow example

name: github_update_issue_workflow
description: Update a GitHub issue
steps:
  - name: update_issue
    type: action
    action: gitHub.issue.update
    version: 1
    inputs:
      token: ${{ :secrets:github-PAT-token }}
      owner: your_user_name
      repo: test-workflow
      issueNumber: 7
      title: Issue has been resolved
      body: Investigation complete. Closing this issue.
      state: closed
      state_reason: completed
      labels:
        - resolved
    next: end