Pull Request Reviews¶

class git_bot_feedback.ReviewOptions¶

A struct to describe a Pull Request review.

Each review is considered to be about the PR event’s changes. There is no support for posting reviews on older/outdated PR events.

action¶: The course of action that the PR review suggests.

allow_closed¶: Allow posting reviews on closed Pull Requests?

allow_draft¶: Allow posting reviews on draft Pull Requests?

comments¶: A list of comments for changes to the PR.

delete_review_comments¶

Permanently delete PR review outdated comments instead of hiding them.

Here be dragons! Use with extreme caution when asserting this flag. Setting this flag as true will permanently delete PR review comments that may be pivotal to a thread of discussion.

Note, this does not apply to PR review summary comments nor threads of discussion within a review.

marker¶

A string used to mark/identify each comment (and [Self::summary]) as a comment submitted by this software.

User comments may be indistinguishable from bot/generated comments if this value is not unique enough.

If the git server employs Markdown syntax for comments, then it is recommended to set this to an HTML comment that is unique to your CI application:

The default value for this is an HTML comment generated from this crate’s name and version along with the compile-tome’s datetime. For example:

summary¶

A summary of the PR review.

This is an overview of the review’s comments.

class git_bot_feedback.ReviewAction¶

An enumeration of possible recommended actions for a Pull Request review.

Approve¶: A review that approves the changes.

RequestChanges¶: A review that requests changes to the code.

Comment¶: A review that comments on the code without approving or requesting changes.

class git_bot_feedback.ReviewComment¶

A struct to describe a single comment in a Pull Request review.

comment¶

The actual comment.

This text can include a code block that demonstrates a suggested change(s).

Typically, the comment should not begin with the [ReviewOptions::marker] value. That is managed by the git-bot-feedback library.

line_end¶: The file’s line number in the diff that ends the focus of the comment’s concerns.

line_start¶: The file’s line number in the diff that begins the the focus of the comment’s concerns.

path¶: The file that this comment pertains to.