Introduction

Meziantou.Framework.CodeOwners parses CODEOWNERS files, the files of GitHub and GitLab repositories that say who owns which files. Use it to build tools on top of the ownership rules of a repository: list the owners of a team, check that every owner is a known user, or request reviewers from your own automation.

What you can do with it

• Parse a file and read its entries, in the order of the file. See Getting started.
• Read the patterns and the owners of each entry: usernames, teams, email addresses and GitLab roles. See Entries and owners.
• Read the GitLab sections, with their default owners, their required number of reviewers and whether they are optional. See GitLab sections.
• Know why a file is invalid, with the line and the position of the error. See Handling errors.

Principles

• The dialect is explicit. GitHub and GitLab do not accept the same syntax, so every parse takes a CodeOwnersDialect. See Choose the dialect.
• A file is valid or it is not. Parsing stops at the first error: you get the error, never a partially parsed file.
• Values are copied out of the content. A parsed file does not reference the string or the span it was parsed from.
• Read-only. The entries, the owners and the sections cannot be modified.
• The library parses, it does not match. It does not tell which entry owns a path: see Limitations.

Namespace

All the types are in the Meziantou.Framework.CodeOwners namespace:

Next steps

• Getting started: install the package and parse your first file.