search

palantir / policy-bot

A GitHub App that enforces approval policies on pull requests
Apache License 2.0
777 stars 108 forks source link

❓ What does the `expand_required_reviewers` option do? #860

Closed marcellino-ornelas closed 1 month ago

marcellino-ornelas commented 1 month ago

Description

Im trying to figure out what the expand_required_reviewers option actually does? Does it post a comment of the require reviews onto the PR? or does it only surface on the UI? If it is a comment, does the comment get updated as rules are completed? Do you have an example/image/etc of what this would look like?

https://github.com/palantir/policy-bot?tab=readme-ov-file#expanding-required-reviewers-

bluekeyes commented 1 month ago

Good question, we should probably add some more information to the README. This is a UI-only feature that shows the list of users who are able to approve a specific rule. Here's a redacted screenshot from our internal instance - the blocked names are other users who are allowed to approve:

expanded-reviewers

When you first expand the "Details" section for a rule, it triggers a background request to populate this list of users.

marcellino-ornelas commented 1 month ago

ahhh got ya thank you for the explanation and example 🙏🏽 Yes!! more information about this in the read me would be great 🙌🏽