CodeOwners

PAGE.CodeOwners

[]string

GitHub and GitLab support CODEOWNERS files. This file specifies the users responsible for developing and maintaining software and documentation. This definition can apply to the entire repository, specific directories, or to individual files. To learn more:

• GitHub CODEOWNERS documentation
• GitLab CODEOWNERS documentation

Use the CodeOwners method on a Page object to determine the code owners for the given page.

To use the CodeOwners method you must enable access to your local Git repository:

enableGitInfo: true

enableGitInfo = true

{
   "enableGitInfo": true
}

Consider this project structure:

my-project/
├── content/
│   ├── books/
│   │   └── les-miserables.md
│   └── films/
│       └── the-hunchback-of-notre-dame.md
└── CODEOWNERS

And this CODEOWNERS file:

* @jdoe
/content/books/ @tjones
/content/films/ @mrichards @rsmith

The table below shows the slice of code owners returned for each file:

Render the code owners for each content page:

{{ range .CodeOwners }}
  {{ . }}
{{ end }}

Combine this method with resources.GetRemote to retrieve names and avatars from your Git provider by querying their API.