GitHub App icon

GitHub App

Consume GitHub API using GitHub App authentication

Actions36

Review → Create

AI-generated

Overview

This node operation creates a review for a specified pull request in a GitHub repository. It allows users to approve the pull request, request changes, comment without approval, or mark the review as pending. This is useful for automating code review workflows in software development projects hosted on GitHub, enabling integration with CI/CD pipelines or project management tools.

Use Case Examples

  1. Automatically approve a pull request after successful automated tests.
  2. Request changes on a pull request when certain code quality checks fail.
  3. Add a comment to a pull request to provide feedback without approving or requesting changes.

Properties

Name Meaning
Repository Owner The owner of the GitHub repository where the pull request exists. 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 review.
Event The review action to perform on the pull request, such as Approve, Request Change, Comment, or Pending.
Body The body text of the review, required when the event is Request Changes or Comment.
Additional Fields Optional additional fields for the review, such as specifying a commit ID if different from the latest.

Output

JSON

  • id - The unique identifier of the created review.
  • node_id - The node identifier of the review.
  • user
    • login - The username of the reviewer.
  • body - The body content of the review.
  • state - The state of the review (e.g., APPROVED, CHANGES_REQUESTED, COMMENTED, PENDING).
  • submitted_at - The timestamp when the review was submitted.

Dependencies

  • GitHub API

Troubleshooting

  • Ensure the pull request number is correct and exists in the specified repository.
  • The 'Body' field is required when the event is 'Request Changes' or 'Comment'; omitting it will cause an error.
  • Authentication errors may occur if the GitHub App credentials are invalid or lack necessary permissions.

Links

Discussion