GitHub App icon

GitHub App

Consume GitHub API using GitHub App authentication

Review → Get

AI-generated

Overview

This node operation retrieves a specific review for a pull request in a GitHub repository using GitHub App authentication. It requires the repository owner, repository name, pull request number, and review ID as inputs. The node sends a GET request to the GitHub API to fetch the review details. This operation is useful for developers or teams who want to programmatically access detailed information about a particular review on a pull request, such as comments, review state, and reviewer information, enabling automation and integration with other workflows.

Use Case Examples

  1. Fetch a review for a pull request to analyze code review comments and status.
  2. Integrate with CI/CD pipelines to automatically retrieve review details for reporting or further processing.

Properties

Name Meaning
Repository Owner The owner of the GitHub repository, specified by username or organization name.
Repository Name The name of the GitHub repository.
PR Number The number of the pull request for which the review is to be retrieved.
Review ID The unique identifier of the review to retrieve.

Output

JSON

  • id - The unique identifier of the review.
  • user
    • login - The username of the reviewer.
  • body - The content/body of the review.
  • state - The state of the review (e.g., approved, changes requested, commented).
  • submitted_at - The timestamp when the review was submitted.

Dependencies

  • GitHub API accessed via GitHub App authentication using an API key credential.

Troubleshooting

  • Ensure the provided repository owner and repository name are correct and accessible by the GitHub App installation.
  • Verify that the pull request number and review ID correspond to existing entities in the repository.
  • Check that the GitHub App credentials are valid and have the necessary permissions to access pull request reviews.
  • Common error: 'The resource "review" is not known!' indicates an incorrect resource parameter; ensure 'review' is selected.
  • Common error: 'Failed to authenticate with GitHub App' suggests issues with the GitHub App credentials or private key format.

Links

Discussion