forgejo-federation/docs/content/doc/usage/code-owners.en-us.md
Vladimir Buyanov 3bdd48016f
Add codeowners feature (#24910)
Hello.
This PR adds a github like configuration for the CODEOWNERS file.

Resolves: #10161
2023-06-08 16:56:05 +08:00

1.3 KiB

date title slug weight toc draft aliases menu
2023-05-24T16:00:00+00:00 Code Owners code-owners 30 false false
/en-us/code-owners
sidebar
parent name weight identifier
usage Code Owners 30 code-owners

Code Owners

Gitea maintains code owner files. It looks for it in the following locations in this order:

  • ./CODEOWNERS
  • ./docs/CODEOWNERS
  • ./.gitea/CODEOWNERS

And stops at the first found file.

File format: <regexp rule> <@user or @org/team> [@user or @org/team]...

Regexp specified in golang Regex format. Regexp can start with ! for negative rules - match all files except specified.

Example file:

.*\\.go @user1 @user2 # This is comment

# Comment too
# You can assigning code owning for users or teams
frontend/src/.*\\.js @org1/team1 @org1/team2 @user3

# You can use negative pattern
!frontend/src/.* @org1/team3 @user5

# You can use power of go regexp
docs/(aws|google|azure)/[^/]*\\.(md|txt) @user8 @org1/team4
!/assets/.*\\.(bin|exe|msi) @user9

Escaping

You can escape characters #, (space) and \ with \, like:

dir/with\#hashtag @user1
path\ with\ space @user2
path/with\\backslash @user3

Some character (.+*?()|[]{}^$\) should be escaped with \\ inside regexp, like:

path/\\.with\\.dots
path/with\\+plus