From 1379ea86f50f88708ca3704a4ee9847ec744dfad Mon Sep 17 00:00:00 2001 From: Nick Mowen Date: Fri, 21 Jul 2023 13:56:01 -0600 Subject: [PATCH] Update codeowners docs --- docs/docs/development/contributing-boards.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/docs/development/contributing-boards.md b/docs/docs/development/contributing-boards.md index 401ffbe15..49a65722d 100644 --- a/docs/docs/development/contributing-boards.md +++ b/docs/docs/development/contributing-boards.md @@ -42,10 +42,6 @@ push-rpi: build-rpi docker buildx bake --push --file=docker/board/board.hcl --set board.tags=$(IMAGE_REPO):${GITHUB_REF_NAME}-$(COMMIT_HASH)-board bake-target # Replace `board` with the board suffix ex: rpi. Bake target is the target in the board.hcl file ex: board ``` -### Code Owner File - -A file called `codeowners.json` should be added in `docker/board/` with the contents `[@github_username]` where `@github_username` is a comma separated list of the GitHub usernames of the code owners for that particular community board. This makes it easy to assign support issues and PRs to the appropriate users. - ### Dockerfile The `Dockerfile` is what orchestrates the build, this will vary greatly depending on the board but some parts are required for things to work. Below are the required parts of the Dockerfile: @@ -89,6 +85,10 @@ The images for each board will be built for each Frigate release, this is done i *.cache-from=type=gha ``` +### Code Owner File + +The `CODEOWNERS` file should be updated to include the `docker/board` along with `@user` for each user that is a code owner of this board + # Docs At a minimum the `installation`, `object_detectors`, `hardware_acceleration`, and `ffmpeg-presets` docs should be updated (if applicable) to reflect the configuration of this community board.