devcontainer.yml

# Copyright 2024 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

name: Dev Container Image Build
on:
  workflow_dispatch: # Allows manual triggering
  schedule:
    - cron: '0 0 * * 2' # Runs every Tuesday at midnight UTC

permissions:
  contents: read
  packages: write

env:
  GO_VERSION: '1.25'
  NODE_VERSION: '24'
  GO_CACHE_DEPENDENCY_PATH: '**/*.sum'

jobs:
  build-base-image:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout (GitHub)
        uses: actions/checkout@v6
      - name: Get Repo Owner
        id: get_repo_owner
        run: echo "REPO_OWNER=$(echo ${{ github.repository_owner }} | tr '[:upper:]' '[:lower:]')" > $GITHUB_ENV
      - name: Login to GitHub Container Registry
        uses: docker/login-action@v4
        with:
          registry: ghcr.io
          username: ${{ env.REPO_OWNER }}
          password: ${{ secrets.GITHUB_TOKEN }}
      - name: Pre-build dev container base image
        uses: devcontainers/ci@v0.3
        with:
          imageName: ghcr.io/${{ env.REPO_OWNER }}/webstatus-dev-devcontainer
          cacheFrom: ghcr.io/${{ env.REPO_OWNER }}/webstatus-dev-devcontainer
          push: always

  # Run the precommit action to build language/tool specific caches
  # The precommit action currently is configured to cache:
  # - Go packages
  # - Node packages
  warm-up-precommit-action:
    runs-on: ubuntu-latest
    needs: build-base-image
    steps:
      - name: Maximize build space
        uses: easimon/maximize-build-space@fc881a613ad2a34aca9c9624518214ebc21dfc0c
        with:
          remove-dotnet: 'true'
          remove-android: 'true'
          remove-haskell: 'true'
          remove-codeql: 'true'
          # Lower reserve to 2GB just for OS overhead; Docker moves to the big partition below
          root-reserve-mb: 2048
          overprovision-lvm: 'true'
          build-mount-path: '/home/runner/work/webstatus.dev'
        continue-on-error: true
      #  Create the folder structure on the new disk
      #  We need to recreate the repo folder because the mount starts empty.
      - name: Create Workspace
        run: mkdir -p ${{ github.workspace }}
      - name: Checkout (GitHub)
        uses: actions/checkout@v6
      - name: Move Docker
        run: |
          sudo service docker stop
          mkdir -p ../docker-storage
          sudo rm -rf /var/lib/docker
          sudo ln -s $(realpath ../docker-storage) /var/lib/docker
          sudo service docker start
      - name: check storage
        run: |
          sudo df -h
          echo "Docker Root Dir:"
          sudo docker info | grep "Docker Root Dir"
      - uses: actions/setup-go@v6
        with:
          go-version: ${{ env.GO_VERSION }}
          cache-dependency-path: ${{ env.GO_CACHE_DEPENDENCY_PATH }}
      - uses: actions/setup-node@v6
        with:
          node-version: ${{ env.NODE_VERSION }}
          cache: 'npm'
      - name: Get Repo Owner
        id: get_repo_owner
        run: echo "REPO_OWNER=$(echo ${{ github.repository_owner }} | tr '[:upper:]' '[:lower:]')" > $GITHUB_ENV
      - name: Run precommit target for CI
        uses: devcontainers/ci@v0.3
        with:
          cacheFrom: ghcr.io/${{ env.REPO_OWNER }}/webstatus-dev-devcontainer
          push: never
          runCmd: make precommit

  # Currently, this action does not cache anything.
  # However, we should run it as a sanity check to make sure the devcontainer
  # is not broken.
  test-playwright-action:
    runs-on: ubuntu-latest
    needs: build-base-image
    steps:
      - name: Maximize build space
        uses: easimon/maximize-build-space@fc881a613ad2a34aca9c9624518214ebc21dfc0c
        with:
          remove-dotnet: 'true'
          remove-android: 'true'
          remove-haskell: 'true'
          remove-codeql: 'true'
          # Lower reserve to 2GB just for OS overhead; Docker moves to the big partition below
          root-reserve-mb: 2048
          overprovision-lvm: 'true'
          build-mount-path: '/home/runner/work/webstatus.dev'
        continue-on-error: true
      #  Create the folder structure on the new disk
      #  We need to recreate the repo folder because the mount starts empty.
      - name: Create Workspace
        run: mkdir -p ${{ github.workspace }}
      - name: Checkout (GitHub)
        uses: actions/checkout@v6
      - name: Move Docker
        run: |
          sudo service docker stop
          mkdir -p ../docker-storage
          sudo rm -rf /var/lib/docker
          sudo ln -s $(realpath ../docker-storage) /var/lib/docker
          sudo service docker start
      - name: check storage
        run: |
          sudo df -h
          echo "Docker Root Dir:"
          sudo docker info | grep "Docker Root Dir"
      - uses: actions/setup-go@v6
        with:
          go-version: ${{ env.GO_VERSION }}
          cache-dependency-path: ${{ env.GO_CACHE_DEPENDENCY_PATH }}
      - uses: actions/setup-node@v6
        with:
          node-version: ${{ env.NODE_VERSION }}
          cache: 'npm'
      - name: Get Repo Owner
        id: get_repo_owner
        run: echo "REPO_OWNER=$(echo ${{ github.repository_owner }} | tr '[:upper:]' '[:lower:]')" > $GITHUB_ENV
      - name: Run playwright-test target for CI
        uses: devcontainers/ci@v0.3
        with:
          cacheFrom: ghcr.io/${{ env.REPO_OWNER }}/webstatus-dev-devcontainer
          push: never
          runCmd: CI=true make playwright-test
      - uses: actions/upload-artifact@v7
        if: ${{ !cancelled() }}
        with:
          name: playwright-report
          path: playwright-report/
          retention-days: 30