Add support for approval conditions #752
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Many users try to use Policy Bot as a general purpose rule engine, constructing policies that enforce things about status checks, labels, and other conditions. This was poorly supported because predicates skip rules when the conditions don't match, whereas users working in this model expect the rule to apply, but remain in the pending state. This commit introduces the concept of "conditions", which are predicates that count toward approval. All of the existing predicates tests are available, but when used as a condition they control whether the rule is pending or approved, instead of active or skipped. Conditions can combine with regular approval requirements, but I expect most uses will either use predicates and regular approval or conditions without additional approval. Due to limitations in how predicates work internally, the details UI shows limited information about conditions. I hope to fix this in a follow-up, but I wanted to separate the main change from the predicate refactoring. Finally, this adds a new README section explaining how to design a policy and what all the different terms mean.
|
I think this is a good solution. |
asvoboda
previously approved these changes
Apr 8, 2024
| @@ -213,6 +221,11 @@ | |||
|
|
|||
| {{define "result-reviews-count"}}This rule requires at least {{.Count}} approval{{if gt .Count 1}}s{{end}}{{end}} | |||
|
|
|||
| {{define "result-conditions-details"}} | |||
| {{/* TODO(bkeyes): this is a placeholder until I can refactor predicate rendering */}} | |||
There was a problem hiding this comment.
If this something you want to do in a follow up PR?
There was a problem hiding this comment.
Yeah, trying to refactor the predicate display in this PR was going to overwhelm the actual changes.
nvelat
approved these changes
Apr 8, 2024
|
If you are able to deploy snapshot versions, this feature is now available in the |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Many users try to use Policy Bot as a general purpose rule engine, constructing policies that enforce things about status checks, labels, and other conditions. This was poorly supported because predicates skip rules when the conditions don't match, whereas users working in this model expect the rule to apply, but remain in the pending state.
This commit introduces the concept of "conditions", which are predicates that count toward approval. All of the existing predicates tests are available, but when used as a condition they control whether the rule is pending or approved, instead of active or skipped.
Conditions can combine with regular approval requirements, but I expect most uses will either use predicates and regular approval or conditions without additional approval.
Due to limitations in how predicates work internally, the details UI shows limited information about conditions. I hope to fix this in a follow-up, but I wanted to separate the main change from the predicate refactoring.
Finally, this adds a new README section explaining how to design a policy and what all the different terms mean.
I'm open to a different name for this new feature, since it's easy to accidentally say "condition" when talking about predicates, but I couldn't think of anything else that fit better.
This is an alternative to #750, which only works for status checks. See also #627.