search

mszostok / codeowners-validator

The GitHub CODEOWNERS file validator
Apache License 2.0
211 stars 48 forks source link

Feature request: fail for deleted files that are explicitly owned in CODEOWNERS #196

Open devth opened 1 year ago

devth commented 1 year ago

Description

If I have a file foo/bar.go explicitly covered by CODEOWNERS, e.g.

foo/bar.go @org/team

and I open a PR which deletes foo/bar.go, I'd like codeowners-validator to fail with a message saying something like:

File foo/bar.go does not exist, yet is covered in CODEOWENERS line 1 by the rule foo/bar.go @org/team

Reasons

You could argue that a CODEOWNERS file that contains rules for non-existent files is invalid. An error like above (maybe it's configurable) would prevent CODEOWNERS files from getting stale.

devth commented 1 year ago

👋🏻 Would you be open to a PR for this?

mszostok commented 1 year ago

Hi @devth

I like the idea that you posted, and PR is always welcome 👍 I will do my best to do the review ASAP 👍

devth commented 1 year ago

Thanks! I'll see when I get to it.

Do you think this behavior should be configurable, or always on?

mszostok commented 1 year ago

I try to maintain a behavior where all checks are optional, so each one can always enable what they really need to 👍