steampipe plugin install github

Table: github_pull_request_review - Query GitHub Pull Request Reviews using SQL

A GitHub Pull Request Review is a feature within GitHub that allows users to provide feedback on pull requests. It provides a collaborative platform for code review where users can comment, approve or request changes on the proposed code changes. GitHub Pull Request Reviews help to ensure code quality and maintainability by facilitating peer review before code merging.

Table Usage Guide

The github_pull_request_review table provides insights into the review process of pull requests within GitHub. As a developer or a team lead, explore review-specific details through this table, including the review comments, review status, and the reviewer details. Utilize it to understand the feedback on pull requests, the approval process, and to gain insights into the code review practices in your projects.

Important Notes

  • You must specify the repository_full_name (repository including org/user prefix) and number (of the PR) columns in the where or join clause to query the table.

Examples

List all reviews for a specific pull request

Explore all feedback for a specific project update. This is particularly useful for developers and project managers who want to understand the team's thoughts, concerns, and suggestions regarding a particular code change or feature addition.

select
id,
author_login,
author_association,
state,
body,
submitted_at,
url
from
github_pull_request_review
where
repository_full_name = 'turbot/steampipe-plugin-github'
and number = 207;
select
id,
author_login,
author_association,
state,
body,
submitted_at,
url
from
github_pull_request_review
where
repository_full_name = 'turbot/steampipe-plugin-github'
and number = 207;

List reviews for a specific pull request which match a certain body content

This query is useful for identifying specific feedback within the reviews of a particular pull request. It can help you to pinpoint comments that match a certain keyword, enabling you to quickly find and address relevant concerns or suggestions.

select
id,
number as issue,
author_login as comment_author,
author_association,
body as content,
submitted_at,
url
from
github_pull_request_review
where
repository_full_name = 'turbot/steampipe-plugin-github'
and number = 207
and body like '%minor%';
select
id,
number as issue,
author_login as comment_author,
author_association,
body as content,
submitted_at,
url
from
github_pull_request_review
where
repository_full_name = 'turbot/steampipe-plugin-github'
and number = 207
and body like '%minor%';

List reviews for all open pull requests from a specific repository

Determine the areas in which feedback has been provided for all active changes proposed in a specific project. This can be useful to understand the type of improvements or modifications suggested by contributors during the development process.

select
rv.*
from
github_pull_request r
join github_pull_request_review rv on r.repository_full_name = rv.repository_full_name
and r.number = rv.number
where
r.repository_full_name = 'turbot/steampipe-plugin-github'
and r.state = 'OPEN';
select
rv.*
from
github_pull_request r
join github_pull_request_review rv on r.repository_full_name = rv.repository_full_name
and r.number = rv.number
where
r.repository_full_name = 'turbot/steampipe-plugin-github'
and r.state = 'OPEN';

Schema for github_pull_request_review

NameTypeOperatorsDescription
_ctxjsonbSteampipe context in JSON form, e.g. connection_name.
authorjsonbThe actor who authored the review.
author_associationtextAuthor's association with the subject of the pr the review was raised on.
author_can_push_to_repositorybooleanIndicates whether the author of this review has push access to the repository.
author_logintextThe login of the review author.
bodytextThe body of the review.
idbigintThe ID of the review.
node_idtextThe node ID of the review.
numberbigint=The PR number.
repository_full_nametext=The full name of the repository (login/repo-name).
statetextThe state of the review.
submitted_attimestamp with time zoneIdentifies when the Pull Request Review was submitted.
urltextThe HTTP URL permalink for this PullRequestReview.

Export

This table is available as a standalone Exporter CLI. Steampipe exporters are stand-alone binaries that allow you to extract data using Steampipe plugins without a database.

You can download the tarball for your platform from the Releases page, but it is simplest to install them with the steampipe_export_installer.sh script:

/bin/sh -c "$(curl -fsSL https://steampipe.io/install/export.sh)" -- github

You can pass the configuration to the command with the --config argument:

steampipe_export_github --config '<your_config>' github_pull_request_review