GitHub App icon

GitHub App

Consume GitHub API using GitHub App authentication

Actions36

Review → Update

AI-generated

Overview

This node operation updates a review on a GitHub pull request. It allows users to modify the body content of an existing review identified by its review ID and associated pull request number within a specified repository and owner. This is useful for managing code review comments and feedback on pull requests programmatically, such as updating review comments or notes after initial submission.

Use Case Examples

  1. Updating the body of a code review on a pull request to add additional comments or clarifications.
  2. Modifying a previously submitted review to correct or enhance the feedback provided.

Properties

Name Meaning
Repository Owner The owner of the GitHub repository where the pull request 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 pull request. Can be selected from a list, provided as a URL, or entered by name.
PR Number The number of the pull request to which the review belongs.
Review ID The unique identifier of the review to update.
Body The updated text content of the review body.

Output

JSON

  • id - The unique identifier of the updated review.
  • node_id - The node identifier of the review.
  • user
    • login - The username of the reviewer.
  • body - The updated body content of the review.
  • state - The state of the review (e.g., approved, commented).
  • submitted_at - The timestamp when the review was submitted.
  • pull_request_url - The URL of the pull request associated with the review.

Dependencies

  • GitHub API access via GitHub App authentication

Troubleshooting

  • Ensure the 'Repository Owner' and 'Repository Name' are correctly specified and accessible with the provided credentials.
  • Verify that the 'PR Number' and 'Review ID' correspond to existing pull request and review in the repository.
  • Check that the GitHub App credentials have the necessary permissions to update pull request reviews.
  • Common error: 'The resource "review" is not known!' indicates an incorrect resource or operation selection.
  • Invalid JSON or missing required parameters in the 'Body' field can cause request failures.

Links

Discussion