Merge pull request #4055 from blakeblackshear/dev

0.12.0 Release

.devcontainer/devcontainer.json

@@ -1,30 +1,68 @@
 {
-  "name": "Frigate Dev",
+  "name": "Frigate Devcontainer",
   "dockerComposeFile": "../docker-compose.yml",
-  "service": "dev",
-  "workspaceFolder": "/lab/frigate",
+  "service": "devcontainer",
+  "workspaceFolder": "/workspace/frigate",
+  "initializeCommand": ".devcontainer/initialize.sh",
+  "postCreateCommand": ".devcontainer/post_create.sh",
+  "overrideCommand": false,
+  "remoteUser": "vscode",
+  "features": {
+    "ghcr.io/devcontainers/features/common-utils:1": {}
+  },
+  "forwardPorts": [5000, 5001, 5173, 1935, 8554, 8555],
+  "portsAttributes": {
+    "5000": {
+      "label": "NGINX",
+      "onAutoForward": "silent"
+    },
+    "5001": {
+      "label": "Frigate API",
+      "onAutoForward": "silent"
+    },
+    "5173": {
+      "label": "Vite Server",
+      "onAutoForward": "silent"
+    },
+    "1935": {
+      "label": "RTMP",
+      "onAutoForward": "silent"
+    },
+    "8554": {
+      "label": "gortc RTSP",
+      "onAutoForward": "silent"
+    },
+    "8555": {
+      "label": "go2rtc WebRTC",
+      "onAutoForward": "silent"
+    }
+  },
   "extensions": [
+    "ms-python.vscode-pylance",
     "ms-python.python",
     "visualstudioexptteam.vscodeintellicode",
     "mhutchie.git-graph",
     "ms-azuretools.vscode-docker",
     "streetsidesoftware.code-spell-checker",
     "esbenp.prettier-vscode",
-    "ms-python.vscode-pylance",
     "dbaeumer.vscode-eslint",
     "mikestead.dotenv",
     "csstools.postcss",
     "blanu.vscode-styled-jsx",
     "bradlc.vscode-tailwindcss"
   ],
   "settings": {
+    "remote.autoForwardPorts": false,
     "python.linting.pylintEnabled": true,
     "python.linting.enabled": true,
     "python.formatting.provider": "black",
     "python.languageServer": "Pylance",
     "editor.formatOnPaste": false,
     "editor.formatOnSave": true,
     "editor.formatOnType": true,
+    "python.testing.pytestEnabled": false,
+    "python.testing.unittestEnabled": true,
+    "python.testing.unittestArgs": ["-v", "-s", "./frigate/test"],
     "files.trimTrailingWhitespace": true,
     "eslint.workingDirectories": ["./web"],
     "[json][jsonc]": {

.devcontainer/initialize.sh

@@ -0,0 +1,13 @@
+#!/bin/bash
+
+set -euo pipefail
+
+# These folders needs to be created and owned by the host user
+mkdir -p debug web/dist
+
+if [[ -f "config/config.yml" ]]; then
+  echo "config/config.yml already exists, skipping initialization" >&2
+else
+  echo "initializing config/config.yml" >&2
+  cp -fv config/config.yml.example config/config.yml
+fi

.devcontainer/post_create.sh

@@ -0,0 +1,17 @@
+#!/bin/bash
+
+set -euxo pipefail
+
+# Frigate normal container runs as root, so it have permission to create
+# the folders. But the devcontainer runs as the host user, so we need to
+# create the folders and give the host user permission to write to them.
+sudo mkdir -p /media/frigate
+sudo chown -R "$(id -u):$(id -g)" /media/frigate
+
+make version
+
+cd web
+
+npm install
+
+npm run build

.dockerignore

@@ -9,4 +9,8 @@ core
 *.mp4
 *.jpg
 *.db
-*.ts
+*.ts
+
+web/dist/
+web/node_modules/
+web/.npm

.github/ISSUE_TEMPLATE/edgetpu_support_request.yml → .github/ISSUE_TEMPLATE/detector_support_request.yml

@@ -1,6 +1,6 @@
-name: EdgeTpu Support Request
-description: Support for setting up EdgeTPU in Frigate
-title: "[EdgeTPU Support]: "
+name: Detector Support Request
+description: Support for setting up object detector in Frigate (Coral, OpenVINO, TensorRT, etc.)
+title: "[Detector Support]: "
 labels: ["support", "triage"]
 assignees: []
 body:

.github/dependabot.yml

@@ -0,0 +1,32 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: daily
+    open-pull-requests-limit: 10
+    target-branch: dev
+  - package-ecosystem: "docker"
+    directory: "/docker"
+    schedule:
+      interval: daily
+    open-pull-requests-limit: 10
+    target-branch: dev
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: daily
+    open-pull-requests-limit: 10
+    target-branch: dev
+  - package-ecosystem: "npm"
+    directory: "/web"
+    schedule:
+      interval: daily
+    open-pull-requests-limit: 10
+    target-branch: dev
+  - package-ecosystem: "npm"
+    directory: "/docs"
+    schedule:
+      interval: daily
+    open-pull-requests-limit: 10
+    target-branch: dev

.github/workflows/ci.yml

@@ -0,0 +1,67 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - dev
+      - master
+
+# only run the latest commit to avoid cache overwrites
+concurrency:
+  group: ${{ github.ref }}
+  cancel-in-progress: true
+
+env:
+  PYTHON_VERSION: 3.9
+
+jobs:
+  multi_arch_build:
+    runs-on: ubuntu-latest
+    name: Image Build
+    steps:
+      - name: Remove unnecessary files
+        run: |
+          sudo rm -rf /usr/share/dotnet
+          sudo rm -rf /usr/local/lib/android
+          sudo rm -rf /opt/ghc
+      - id: lowercaseRepo
+        uses: ASzc/change-string-case-action@v5
+        with:
+          string: ${{ github.repository }}
+      - name: Check out code
+        uses: actions/checkout@v3
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v2
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+      - name: Log in to the Container registry
+        uses: docker/login-action@f4ef78c080cd8ba55a85445d5b36e214a81df20a
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+      - name: Create version file
+        run: make version
+      - name: Create short sha
+        run: echo "SHORT_SHA=${GITHUB_SHA::7}" >> $GITHUB_ENV
+      - name: Build and push
+        uses: docker/build-push-action@v3
+        with:
+          context: .
+          push: true
+          platforms: linux/amd64,linux/arm64,linux/arm/v7
+          target: frigate
+          tags: |
+            ghcr.io/${{ steps.lowercaseRepo.outputs.lowercase }}:${{ github.ref_name }}-${{ env.SHORT_SHA }}
+          cache-from: type=gha
+          cache-to: type=gha,mode=max
+      - name: Build and push TensorRT
+        uses: docker/build-push-action@v3
+        with:
+          context: .
+          push: true
+          platforms: linux/amd64
+          target: frigate-tensorrt
+          tags: |
+            ghcr.io/${{ steps.lowercaseRepo.outputs.lowercase }}:${{ github.ref_name }}-${{ env.SHORT_SHA }}-tensorrt
+          cache-from: type=gha

.github/workflows/dependabot-auto-merge.yaml

@@ -0,0 +1,22 @@
+name: dependabot-auto-merge
+on: pull_request
+
+permissions:
+  contents: write
+
+jobs:
+  dependabot-auto-merge:
+    runs-on: ubuntu-latest
+    if: github.actor == 'dependabot[bot]'
+    steps:
+      - name: Get Dependabot metadata
+        id: metadata
+        uses: dependabot/fetch-metadata@v1
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+      - name: Enable auto-merge for Dependabot PRs
+        if: steps.metadata.outputs.dependency-type == 'direct:development' && (steps.metadata.outputs.update-type == 'version-update:semver-minor' || steps.metadata.outputs.update-type == 'version-update:semver-patch')
+        run: gh pr merge --auto --squash "$PR_URL"
+        env:
+          PR_URL: ${{ github.event.pull_request.html_url }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/pull_request.yml

@@ -6,11 +6,35 @@ env:
   DEFAULT_PYTHON: 3.9
 
 jobs:
+  build_devcontainer:
+    runs-on: ubuntu-latest
+    name: Build Devcontainer
+    # The Dockerfile contains features that requires buildkit, and since the
+    # devcontainer cli uses docker-compose to build the image, the only way to
+    # ensure docker-compose uses buildkit is to explicitly enable it.
+    env:
+      DOCKER_BUILDKIT: "1"
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@master
+        with:
+          node-version: 16.x
+      - name: Install devcontainer cli
+        run: npm install --global @devcontainers/cli
+      - name: Build devcontainer
+        run: devcontainer build --workspace-folder .
+      # It would be nice to also test the following commands, but for some
+      # reason they don't work even though in VS Code devcontainer works.
+      # - name: Start devcontainer
+      #   run: devcontainer up --workspace-folder .
+      # - name: Run devcontainer scripts
+      #   run: devcontainer run-user-commands --workspace-folder .
+
   web_lint:
     name: Web - Lint
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@master
+      - uses: actions/checkout@v3
       - uses: actions/setup-node@master
         with:
           node-version: 16.x
@@ -24,7 +48,7 @@ jobs:
     name: Web - Test
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@master
+      - uses: actions/checkout@v3
       - uses: actions/setup-node@master
         with:
           node-version: 16.x
@@ -36,12 +60,12 @@ jobs:
 
   python_checks:
     runs-on: ubuntu-latest
-    name: Python checks
+    name: Python Checks
     steps:
       - name: Check out the repository
-        uses: actions/checkout@v2.3.4
+        uses: actions/checkout@v3
       - name: Set up Python ${{ env.DEFAULT_PYTHON }}
-        uses: actions/setup-python@v2.2.2
+        uses: actions/setup-python@v4.5.0
         with:
           python-version: ${{ env.DEFAULT_PYTHON }}
       - name: Install requirements
@@ -57,7 +81,7 @@ jobs:
     name: Python Tests
     steps:
       - name: Check out code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
       - uses: actions/setup-node@master
         with:
           node-version: 16.x
@@ -67,11 +91,9 @@ jobs:
         run: npm run build
         working-directory: ./web
       - name: Set up QEMU
-        uses: docker/setup-qemu-action@v1
+        uses: docker/setup-qemu-action@v2
       - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v1
-      - name: Create Version Module
-        run: make version
+        uses: docker/setup-buildx-action@v2
       - name: Build
         run: make
       - name: Run mypy

.github/workflows/stale.yml

@@ -6,20 +6,21 @@ name: "Stalebot"
 on:
   schedule:
     - cron: "0 0 * * *" # run stalebot once a day
-    
+
 jobs:
   stale:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/stale@main
         id: stale
         with:
-          stale-issue-message: 'This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.'
-          close-issue-message: ''
+          stale-issue-message: "This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions."
+          close-issue-message: ""
           days-before-stale: 30
           days-before-close: 3
           exempt-draft-pr: true
-          exempt-issue-labels: 'pinned,security'
-          exempt-pr-labels: 'pinned,security'
+          exempt-issue-labels: "pinned,security"
+          exempt-pr-labels: "pinned,security,dependencies"
+          operations-per-run: 120
       - name: Print outputs
         run: echo ${{ join(steps.stale.outputs.*, ',') }}

.gitignore

@@ -2,7 +2,8 @@
 *.pyc
 *.swp
 debug
-.vscode
+.vscode/*
+!.vscode/launch.json
 config/config.yml
 models
 *.mp4

.vscode/launch.json

@@ -0,0 +1,12 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "Python: Launch Frigate",
+      "type": "python",
+      "request": "launch",
+      "module": "frigate",
+      "justMyCode": true
+    }
+  ]
+}