GitHub App icon

GitHub App

Consume GitHub API using GitHub App authentication

Actions36

Issue → Edit

AI-generated

Overview

This node operation edits an existing issue in a specified GitHub repository. It allows users to update various fields of the issue such as the title, body, labels, assignees, state (open or closed), and the reason for the state change. This operation is useful for managing and maintaining issues programmatically within GitHub repositories, enabling automation of issue tracking and updates.

Use Case Examples

  1. Automatically update issue details based on external triggers or workflow results.
  2. Change the state of an issue to 'closed' when a related task is completed.
  3. Add or remove labels and assignees to issues based on project management rules.

Properties

Name Meaning
Repository Owner The owner of the GitHub repository where the issue exists. This can be selected from a list, provided as a URL, or entered by name.
Repository Name The name of the GitHub repository containing the issue. This can be selected from a list, provided as a URL, or entered by name.
Issue Number The number identifier of the issue to be edited in the repository.
Edit Fields The fields of the issue to edit. This includes assignees, body text, labels, state (open or closed), state reason, and title.

Output

JSON

  • id - The unique identifier of the edited issue.
  • number - The issue number in the repository.
  • title - The updated title of the issue.
  • body - The updated body content of the issue.
  • state - The updated state of the issue (open or closed).
  • assignees - List of users assigned to the issue.
  • labels - List of labels assigned to the issue.
  • state_reason - The reason for the state change.

Dependencies

  • GitHub API
  • GitHub App authentication with API key credentials

Troubleshooting

  • Ensure the 'Repository Owner' and 'Repository Name' are correctly specified and accessible with the provided credentials.
  • Verify the 'Issue Number' exists in the specified repository before attempting to edit.
  • Check that the GitHub App has the necessary permissions to edit issues in the repository.
  • Common error: 'The resource "issue" is not known!' indicates an invalid resource selection; verify the resource parameter.
  • Common error: 'Inputs: Invalid JSON' when dispatching workflows indicates malformed JSON input; validate JSON format before submission.

Links

Discussion