Improve the devcontainer experience (#3492)

* Make it easier to run the devcontainer

* Some more improvements

* Tidy up few other things

* Better name stages

* Fix CI

* Setup everything with one click

* Allow to set IMAGE_OWNER

* Change IMAGE_OWNER to IMAGE_REPO

* Fix CI with IMAGE_REPO

* Fix nodejs installation

* Test devcontainer build as part of CI

* Build devcontainer in its own job

* Fix devcontainer cli installation

* Fix devcontainer build

* Fix devcontainer build in CI again

* Enable buildkit only

* Increase coverage of devcontainer test

* Fix devcontainer start in CI

* Ensure latest version of docker compose is used

* Fix install compose action

* Disable CI stuff which does not work until we fix them

.github/workflows/ci.yml

@@ -26,7 +26,7 @@ jobs:
           registry: ghcr.io
           username: ${{ github.actor }}
           password: ${{ secrets.GITHUB_TOKEN }}
-      - name: Build web
-        run: make build_web
       - name: Build image
-        run: make push
+        run: make push
+        env:
+          IMAGE_REPO: ghcr.io/${{ github.actor }}/frigate

.github/workflows/pull_request.yml

@@ -6,6 +6,30 @@ 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
@@ -36,7 +60,7 @@ jobs:
 
   python_checks:
     runs-on: ubuntu-latest
-    name: Python checks
+    name: Python Checks
     steps:
       - name: Check out the repository
         uses: actions/checkout@v3
@@ -70,8 +94,6 @@ jobs:
         uses: docker/setup-qemu-action@v2
       - name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v2
-      - name: Create Version Module
-        run: make version
       - name: Build
         run: make
       - name: Run mypy