What?

This generates your CODEOWNERS file (patterns x users) from

• a VIRTUAL-CODEOWNERS.txt (patterns x teams)
• a virtual-teams.yml (teams x users)

... which makes it easier to keep CODEOWNERS in sync on multi-team mono repos when you don't have (enough) 'real' GitHub or GitLab teams.

Usage

• Rename .github/CODEOWNERS to .github/VIRTUAL-CODEOWNERS.txt and put team names in them.
• Define teams that don't (yet) exist on GitHub level in .github/virtual-teams.yml
• Run this:

npx virtual-code-owners
# Wrote '.github/CODEOWNERS'

• ✨

Formats

VIRTUAL-CODEOWNERS.txt

VIRTUAL-CODEOWNERS.txt sticks to the CODEOWNERS format, but adds the ability to include teams defined in virtual-teams.yml.

For example a CODEOWNERS file can look like this:

#! comments that start with #! won't appear in the CODEOWNERS output
#!
#! this is not the CODEOWNERS file - to get that one run
#!   npx virtual-code-owners
#!
# catch-all to ensure there at least _is_ a code owner, even when
# it's _everyone_

* @cloud-heroes-all

# admin & ci stuff => transversal

.github/            @ch/transversal

# generic stuff

apps/framework/     @ch/transversal
apps/ux-portal/     @ch/ux @ch/transversal
libs/components/    @ch/ux

# specific functionality

libs/sales/         @ch/sales
libs/after-sales/   @ch/after-sales
libs/refund/        @ch/sales @ch/after-sales
libs/baarden/       @ch/mannen-met-baarden

... where only the @cloud-heroes-all is a 'real' team on GitHub level. The other ones are defined in virtual-teams.yml.

virtual-teams.yml

A valid YAML file that contains a list of teams and their members. Update it whenever you have new team members and run npx virtual-code-owners to keep CODEOWNERS current.

# yaml-language-server: $schema=https://raw.githubusercontent.com/sverweij/virtual-code-owners/main/src/virtual-teams.schema.json
ch/after-sales:
  - john-doe-ch
  - pete-peterson-ch
  - john-galt-ch
  - daisy-duck
  - donald-duck
ch/sales:
  - gregory-gregson-ch
  - jane-doe-ch
  - abraham-ableton-ch
  - dagny-taggert-ch
  - karl-marx-ch
ch/ux:
  - davy-davidson-ch
  - john-johnson-ch
  - joe-dalton-ch
  - koos-koets
ch/transversal:
  - mary-the-merry-ch
  - luke-the-lucky-ch
  - benjamin-franklin
  - koos-koets
  - abraham-lincoln
ch/mannen-met-baarden:
  - [email protected]
  - [email protected]
  - [email protected]
  - [email protected]

CODEOWNERS

Running npx virtual-code-owners will combine these into a CODEOWNERS file like this:

#
# DO NOT EDIT - this file is generated and your edits will be overwritten
#
# To make changes:
#
#   - edit .github/VIRTUAL-CODEOWNERS.txt
#   - and/ or add team members to .github/virtual-teams.yml
#   - run 'npx virtual-code-owners' (or 'npx virtual-code-owners --emitLabeler' if you also
#     want to generate a .github/labeler.yml)
#

# catch-all to ensure there at least _is_ a code owner, even when
# it's _everyone_

* @cloud-heroes-all

# admin & ci stuff => transversal

.github/            @abraham-lincoln @benjamin-franklin @koos-koets @luke-the-lucky-ch @mary-the-merry-ch

# generic stuff

apps/framework/     @abraham-lincoln @benjamin-franklin @koos-koets @luke-the-lucky-ch @mary-the-merry-ch
apps/ux-portal/     @abraham-lincoln @benjamin-franklin @davy-davidson-ch @joe-dalton-ch @john-johnson-ch @koos-koets @luke-the-lucky-ch @mary-the-merry-ch
libs/components/    @davy-davidson-ch @joe-dalton-ch @john-johnson-ch @koos-koets

# specific functionality

libs/sales/         @abraham-ableton-ch @dagny-taggert-ch @gregory-gregson-ch @jane-doe-ch @karl-marx-ch
libs/after-sales/   @daisy-duck @donald-duck @john-doe-ch @john-galt @pete-peterson-ch
libs/refund/        @abraham-ableton-ch @dagny-taggert-ch @daisy-duck @donald-duck @gregory-gregson-ch @jane-doe-ch @john-doe-ch @john-galt @karl-marx-ch @pete-peterson-ch
libs/baarden/       [email protected] [email protected] [email protected] [email protected]

FAQ

Any gotcha's?

• It won't check whether the users or teams you entered exist.

Do I have to run this each time I edit VIRTUAL-CODEOWNERS.txt?

Yes. But please automate this for your own sake.

You can for instance set up a rule for lint-staged in a .lintstagedrc.json like this:

{
  ".github/{VIRTUAL-CODEOWNERS.txt,virtual-teams.yml}": [
    "virtual-code-owners",
    "git add ."
  ]
}

Can I mix real and virtual teams in VIRTUAL-CODEOWNERS.txt?

Yes.

It might be you already have a team or two defined, but just want to use additional teams. In that case just don't specify the already-defined teams in virtual-teams.yml and virtual-code-owners will leave them alone.

Can I still use usernames in VIRTUAL-CODEOWNERS.txt?

Yes.

Just make sure there's no name clashes between the username and a (virtual) team name and virtual-code-owners will leave the real name alone.

Can I automatically label PR's for virtual teams?

Yep.

Use actions/labeler and tickle virtual-code-owners to generate the labeler config file:

npx virtual-code-owners --emitLabeler
# Wrote .github/CODEOWNERS AND .github/labeler.yml

If you have an alternate file location for the labeler.yml you can specify that with virtual-code-owner's --labelerLocation parameter.

Note

actions/labeler changed the labeler.yml format from v4 to v5.

• virtual-code-owners < 8.0.0 generates labeler.yml v4 format,
• virtual-code-owners >= 8.0.0 generates labeler.yml v5 format.

see actions/labeler#v5 for details on the v5 format.

What validations does virtual-code-owners perform?

virtual-code-owners checks for basic CODEOWNERS format errors and invalid user/team names but doesn't verify their existence in the project.

• valid user/team names start with an @ or are an e-mail address
• valid rules have a file pattern and at least one user/team name (unless they're in a section that has default owners [sales related] @ch/sales in which case the rule inherits the default owners of that section)
• valid sections headings comply with the syntax described over at GitLab

  different from GitLab's syntax the line [bla @group is not interpreted as a rule, but as an erroneous section heading. This behaviour might change to be the same as GitLab's in future releases without a major version bump.

Does virtual-code-owners support GitLab style sections?

Yes.

I want to specify different locations for the files (e.g. because I'm using GitLab)

Here you go:

npx virtual-code-owners \
  --virtualCodeOwners .gitlab/VIRTUAL-CODEOWNERS.txt \
  --virtualTeams      .gitlab/virtual-teams.yml \
  --codeOwners        .gitlab/CODEOWNERS

Can I just validate VIRTUAL-CODEOWNERS.txt & virtual-teams.yml without generating output?

Sure thing. Use --dryRun:

npx virtual-code-owners --dryRun

Why the .txt extension?

It keeps editors and IDE's from messing up your formatting.

Various editors assume an ALL_CAPS file name with # characters on various lines to be markdown, and will auto format them as such. Usually such autoformatting is not present on text files.

Often these editors know about CODEOWNERS, so they won't confuse those with markdown.

Why does this exist at all? Why not just use GitHub teams?

If you can you should totally use GitHub teams!

Organizations sometimes have large mono repositories with many code owners. They or their bureaucracy haven't landed on actually using GitHub teams to demarcate that. Or you're working on a cross-functional team that doesn't follow the organization chart (and hence the GitHub teams). Teams in those organizations who want to have clear code ownership can either:

• Wrestle the bureaucracy.
  Recommended! It will often require patience though, and in the mean time you might want to have some clarity on code ownership.
• Maintain a CODEOWNERS file with code assigned to large lists of individuals.
  That's a lotta work, even for smaller projects

This is where virtual-code-owners comes in.