improve ci (#254)

Author: ruslandoga

.github/workflows/mix.yml

@@ -10,57 +10,47 @@ on:
 
 jobs:
   test:
+    name: "test (Elixir ${{ matrix.elixir }} / OTP ${{ matrix.otp }} / ClickHouse ${{ matrix.clickhouse || 'latest' }} / TZ ${{ matrix.timezone || 'UTC' }}${{ matrix.dialyzer && ' / Dialyzer' || '' }}${{ matrix.lint && ' / Lint' || '' }})"
     runs-on: ubuntu-latest
 
     strategy:
       matrix:
-        elixir: [1.14, 1.15, 1.16, 1.17]
-        otp: [25, 26]
-        clickhouse: [latest]
-        timezone: [UTC]
         include:
-          - elixir: 1.17
-            otp: 27
-            clickhouse: latest
-            timezone: UTC
+          # some old elixir/erlang version
+          - elixir: 1.14
+            otp: 25
+
+          # some recent version and non-UTC timezone
           - elixir: 1.18
             otp: 27
-            clickhouse: latest
-            timezone: UTC
-          - elixir: 1.18
-            otp: 28
-            clickhouse: latest
-            timezone: UTC
-          - elixir: 1.18
-            otp: 28
-            clickhouse: latest
             timezone: Europe/Berlin
-          # TODO
-          # - elixir: 1.19.0-rc.0
-          #   otp: 28
-          #   clickhouse: latest
-          #   timezone: UTC
-          # Plausible
+
+          # the latest elixir/erlang version with all static checks
+          - elixir: 1.19
+            otp: 28
+            dialyzer: true
+            lint: true
+
+          # Plausible versions
           # - https://github.com/plausible/analytics/blob/master/.tool-versions
           # - https://github.com/plausible/analytics/blob/master/.github/workflows/elixir.yml
           - elixir: 1.19.4
             otp: 27.3.4.6
             clickhouse: 24.12.2.29
-            timezone: UTC
+
           # some older pre-JSON ClickHouse version
           # https://github.com/plausible/ch/issues/273
           - elixir: 1.18
             otp: 28
             clickhouse: 24.5.4.49
-            timezone: UTC
 
     services:
       clickhouse:
-        image: clickhouse/clickhouse-server:${{ matrix.clickhouse }}
+        image: clickhouse/clickhouse-server:${{ matrix.clickhouse || 'latest' }}
         ports:
           - 8123:8123
         env:
-          TZ: ${{ matrix.timezone }}
+          TZ: ${{ matrix.timezone || 'UTC' }}
           # https://github.com/ClickHouse/ClickHouse/issues/75494
           CLICKHOUSE_SKIP_USER_SETUP: 1
           options: >-
@@ -81,7 +71,8 @@ jobs:
           elixir-version: ${{ matrix.elixir }}
           otp-version: ${{ matrix.otp }}
 
-      - uses: actions/cache@v4
+      - name: Restore deps cache
+        uses: actions/cache@v4
         with:
           path: |
             deps
@@ -92,35 +83,29 @@ jobs:
             test-${{ steps.beam.outputs.elixir-version }}-refs/heads/master-
 
       - run: mix deps.get --only $MIX_ENV
-      - run: mix compile --warnings-as-errors
-      - run: mix test
+        if: ${{ !matrix.lint }}
 
-  format:
-    runs-on: ubuntu-latest
+      - run: mix deps.get --check-locked
+        if: ${{ matrix.lint }}
 
-    env:
-      MIX_ENV: prod
+      - run: mix deps.unlock --check-unused
+        if: ${{ matrix.lint }}
 
-    steps:
-      - uses: actions/checkout@v6
+      - run: mix compile --warnings-as-errors
 
-      - id: beam
-        uses: erlef/setup-beam@v1
-        with:
-          elixir-version: 1
-          otp-version: 28
+      - run: mix format --check-formatted
+        if: ${{ matrix.lint }}
 
-      - run: elixir -v
+      - run: mix test
 
-      - uses: actions/cache@v4
+      - name: Restore PLTs cache
+        if: ${{ matrix.dialyzer }}
+        uses: actions/cache@v4
         with:
-          path: |
-            deps
-            _build
-          key: format-${{ steps.beam.outputs.elixir-version }}-${{ github.head_ref || github.ref }}-${{ hashFiles('**/mix.lock') }}
+          path: plts
+          key: plts-${{ steps.beam.outputs.elixir-version }}-${{ steps.beam.outputs.otp-version }}-${{ github.head_ref || github.ref }}
           restore-keys: |
-            format-${{ steps.beam.outputs.elixir-version }}-${{ github.head_ref || github.ref }}-
-            format-${{ steps.beam.outputs.elixir-version }}-refs/heads/master-
+            plts-${{ steps.beam.outputs.elixir-version }}-${{ steps.beam.outputs.otp-version }}-refs/heads/master
 
-      - run: mix deps.get --only $MIX_ENV
-      - run: mix format --check-formatted
+      - run: mix dialyzer --format github
+        if: ${{ matrix.dialyzer }}

.gitignore

@@ -24,3 +24,6 @@ ecto_ch-*.tar
 
 # Temporary files, for example, from tests.
 /tmp/
+
+# Dialyzer PLTs
+/plts/

mix.exs

@@ -16,7 +16,8 @@ defmodule EctoCh.MixProject do
       description: "ClickHouse adapter for Ecto",
       docs: docs(),
       package: package(),
-      source_url: @source_url
+      source_url: @source_url,
+      dialyzer: [plt_local_path: "plts", plt_core_path: "plts", plt_add_apps: [:mix, :ex_unit]]
     ]
   end