✨ Use checks.yaml to store which repo types are supported by each check #1195
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
laurentsimon
requested review from
azeemshaikh38,
inferno-chromium and
naveensrinivasan
as code owners
laurentsimon
changed the title
| @@ -18,6 +18,7 @@ checks: | |||
| Maintained: | |||
| risk: High | |||
| tags: supply-chain, security | |||
| repos: GitHub | |||
There was a problem hiding this comment.
Maybe simpler to add a boolean like run-on-local-files? That way checks.yaml doesn't have to be updated with newer repo implementations.
There was a problem hiding this comment.
If you don't mind, I'll keep it as-is because it lends itself well to supporting other interfaces: gitlab, local-git, etc. I don't think we'll be able to support all of them with a binary "run on local file or not".
laurentsimon
force-pushed
the
feat/localdoc
branch
from
546075b to
4eb271c
Compare
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.
This is a feature with no breaking changes.
close #1184
The general behavior for check selection is as follows:
--repo=X=> uses all checks supported by the repo interface--repo=X --check=Y=> uses check Y and verifies it's supported by repo interface--repo=X --policy=Z=> uses all checks defined in the policy file AND supported by repo interface--repo=X --policy=Z --checks=Y=> uses Y AND verifies Y is defined in the policy and verifies Y checks are supported by the repo interfaceThe one thing I don't like is that, if a user passes a policy, we're silently discarding checks not supported by the interface. I wonder if this may be confusing for users.