test: Added test to check devcontainer successfully builds (#360)

* Added build test for devcontainer

* Edit start docker script for option to run dockerd without sudo

* Point test to dockerfile

* Logging and formatting changes

* Add env for docker in docker support in ci

* Conditionally execute docker start script on creation

* Set CI env to skip docker start script

* Testing if we can test docker in docker

* Add npm dependency for devcontainer on github actions

* Install nodejs on the runner itself

* Also need to preinstall devcontainers

* Using decontainer tool directly now

* Formatting changes

* Added timeout to devcontainer test

Author: Antonio Salinas

.github/workflows/devcontainer.yml

@@ -0,0 +1,43 @@
+name: "Check devcontainer build"
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+  workflow_dispatch:
+  schedule:
+    # Run every night at 3:15am PST (11:15am UTC)
+    - cron: '15 11 * * *'
+
+# Cancel in-progress runs of this workflow if a new run is triggered.
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.run_id }}
+  cancel-in-progress: true
+
+permissions: {}
+
+jobs:
+  devcontainer:
+    name: "Devcontainer build"
+    runs-on:
+      - self-hosted
+      - 1ES.Pool=azl_dev_gh_runner_amd64
+    permissions:
+      contents: read
+    steps:
+      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+        with:
+          persist-credentials: false
+      - name: Install Nodejs and npm
+        run: |
+          sudo tdnf install -y nodejs npm
+          sudo npm install -g @devcontainers/cli
+      - name: Build devcontainer
+        timeout-minutes: 10
+        run: |
+          echo "Building devcontainer..."
+          devcontainer build --workspace-folder . --image-name azldev-devcontainer:test
+          echo "Running devcontainer to verify it works..."
+          devcontainer up --workspace-folder .
+
+          echo "Devcontainer built successfully!"