ci.yml

name: Test + Docker

on:
  push:
    branches:
      - main
    tags:
      - "v*"
  workflow_dispatch:
  pull_request:

jobs:
  report_mix_deps:
    name: "Report Mix Dependencies"

    runs-on: ubuntu-latest

    # The API requires write permission on the repository to submit dependencies
    permissions:
      contents: write

    steps:
      - uses: actions/checkout@v6
      - uses: erlef/mix-dependency-submission@v1
      - uses: actions/dependency-review-action@v4
        if: "${{ github.event_name == 'pull_request' }}"

  compile-and-test:
    runs-on: ubuntu-latest
    timeout-minutes: 14

    permissions:
      contents: read
      packages: read

    env:
      FWUP_VERSION: "1.13.0"
      MIX_ENV: "test"
      DATABASE_URL: postgres://postgres:postgres@localhost:5432/nerves_hub_test
      CLICKHOUSE_URL: http://default:@localhost:8123/default

    services:
      db:
        image: postgres:18
        ports: ["5432:5432"]
        env:
          POSTGRES_PASSWORD: postgres
        options: >-
          --health-cmd pg_isready
          --health-interval 10s
          --health-timeout 5s
          --health-retries 5
      clickhouse:
        image: clickhouse/clickhouse-server:25.4.2.31
        env:
          CLICKHOUSE_SKIP_USER_SETUP: 1
        ports:
          - "8123:8123"
          - "9000:9000"

    steps:
      - name: Install fwup
        run: |
          wget https://github.com/fwup-home/fwup/releases/download/v${FWUP_VERSION}/fwup_${FWUP_VERSION}_amd64.deb
          sudo dpkg -i fwup_${FWUP_VERSION}_amd64.deb && rm fwup_${FWUP_VERSION}_amd64.deb

      - name: Install xdelta3 and mtools
        run: sudo apt-get update && sudo apt-get install -y --no-install-recommends xdelta3 mtools

      - name: Checkout
        uses: actions/checkout@v6

      - name: Set up Node.js
        uses: actions/setup-node@v6
        with:
          node-version: "24"

      - name: Set up Elixir
        id: beam
        uses: erlef/setup-beam@v1
        with:
          version-file: .tool-versions
          version-type: strict

      - name: Cache deps
        id: cache-deps
        uses: actions/cache@v5
        env:
          cache-name: cache-elixir-deps
        with:
          path: deps
          key: ${{ runner.os }}-mix-${{ env.cache-name }}-${{ hashFiles('**/mix.lock') }}
          restore-keys: |
            ${{ runner.os }}-mix-${{ env.cache-name }}-

      - name: Cache compiled build
        id: cache-build
        uses: actions/cache@v5
        env:
          cache-name: cache-compiled-build
        with:
          path: _build
          key: ${{ runner.os }}-mix-${{ env.cache-name }}-${{ hashFiles('**/mix.lock') }}
          restore-keys: |
            ${{ runner.os }}-mix-${{ env.cache-name }}-
            ${{ runner.os }}-mix-

      - name: Clean to rule out incremental build as a source of flakiness
        if: github.run_attempt != '1'
        run: |
          mix deps.clean --all
          mix clean
        shell: sh

      - name: Install dependencies
        run: mix deps.get

      - name: Compiles without warnings
        run: mix compile --warnings-as-errors

      # needed for tailwind class formatting
      - name: Install tailwindcss
        run: mix tailwind.install

      - name: Check Formatting
        run: mix format --check-formatted

      - name: Check for unused dependencies
        run: mix deps.unlock --unused

      - name: Check spelling
        run: mix spellweaver.check

      - name: Run Credo
        run: mix credo --min-priority low

      - name: DB Setup
        run: mix ecto.migrate.reset

      - name: Restore PLT cache
        uses: actions/cache/restore@v5
        id: plt_cache
        with:
          key: |
            ${{ runner.os }}-${{ steps.beam.outputs.elixir-version }}-${{ steps.beam.outputs.otp-version }}-plt
          restore-keys: |
            ${{ runner.os }}-${{ steps.beam.outputs.elixir-version }}-${{ steps.beam.outputs.otp-version }}-plt
          path: |
            priv/plts

      - name: Create PLTs
        if: steps.plt_cache.outputs.cache-hit != 'true'
        run: mix dialyzer --plt

      - name: Save PLT cache
        uses: actions/cache/save@v5
        if: steps.plt_cache.outputs.cache-hit != 'true'
        id: plt_cache_save
        with:
          key: |
            ${{ runner.os }}-${{ steps.beam.outputs.elixir-version }}-${{ steps.beam.outputs.otp-version }}-plt
          path: |
            priv/plts

      - name: Run dialyzer
        run: mix dialyzer --format github --format dialyxir

      - name: Run tests
        run: mix test --include mtools

  build-and-publish:
    runs-on: ubuntu-latest

    needs: compile-and-test

    permissions:
      contents: read
      packages: write

    steps:
      - name: Checkout repository
        uses: actions/checkout@v6

      - name: Log in to the Container registry
        uses: docker/login-action@v4
        with:
          registry: ghcr.io
          username: ${{ github.actor }}
          password: ${{ secrets.GITHUB_TOKEN }}

      - name: Extract metadata (tags, labels) for Docker
        id: meta
        uses: docker/metadata-action@v6
        env:
          DOCKER_METADATA_PR_HEAD_SHA: true
        with:
          images: ghcr.io/nerves-hub/nerves-hub
          tags: |
            # short sha
            type=sha,prefix=,suffix=,format=short
            # branch image names, except for main
            type=ref,enable=${{ github.ref != format('refs/heads/{0}', 'main') }},event=branch
            # latest tag for main branch
            type=raw,enable={{is_default_branch}},value=latest
            # tag event (eg. "v1.2.3")
            type=ref,event=tag

      - name: Check if PR publish
        continue-on-error: true
        if: ${{ github.event_name == 'pull_request' }}
        id: pr_publish_check
        env:
          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        run: |
          commits=$(gh pr view ${{ github.event.pull_request.number }} --json commits --jq '.commits[] | .messageHeadline + " " + .messageBody')

          if [[ $commits =~ \[publish\] ]]; then
            echo "true"
            echo "publish=true" >> $GITHUB_OUTPUT
          else
            echo "false"
            echo "publish=false" >> $GITHUB_OUTPUT
          fi

      - name: Build and push Docker image
        uses: docker/build-push-action@v7
        with:
          context: .
          push: ${{ steps.pr_publish_check.outputs.publish == 'true' || github.event_name == 'workflow_dispatch' || github.ref == 'refs/heads/main' || github.ref_type == 'tag' }}
          tags: ${{ steps.meta.outputs.tags }}
          labels: ${{ steps.meta.outputs.labels }}