CodeOwners
GitHub 和 GitLab 支援 CODEOWNERS 檔案。這個檔案指定了負責開發和維護軟件和文檔的使用者。這個定義可以應用於整個倉庫、特定目錄或單個文件。了解更多:
使用 CodeOwners
方法對於一個 Page
物件,來確定給定頁面的代碼擁有者。
要使用 CodeOwners
方法,你必須啟用對本地 Git 倉庫的存取:
enableGitInfo = true
考慮以下的專案結構:
my-project/
├── content/
│ ├── books/
│ │ └── les-miserables.md
│ └── films/
│ └── the-hunchback-of-notre-dame.md
└── CODEOWNERS
以及這個 CODEOWNERS 文件:
* @jdoe
/content/books/ @tjones
/content/films/ @mrichards @rsmith
以下表格顯示了對於每個文件返回的代碼擁有者切片:
路徑 | 代碼擁有者 |
---|---|
books/les-miserables.md |
[@tjones] |
films/the-hunchback-of-notre-dame.md |
[@mrichards @rsmith] |
渲染每個內容頁面的代碼擁有者:
{{ range .CodeOwners }}
{{ . }}
{{ end }}
結合這個方法與 resources.GetRemote
,你可以通過查詢 Git 提供者的 API 來檢索名字和頭像。