Skip to content

convert CI compat jobs into single matrix job #106

convert CI compat jobs into single matrix job

convert CI compat jobs into single matrix job #106

Workflow file for this run

name: CI
on:
pull_request:
branches:
- "**"
push:
branches:
- main
env:
MIX_ENV: test
LATEST_ELIXIR: 1.18.x
LATEST_OTP: 27.2.x
jobs:
elixir_compatibility:
name: "Check library against a compatability matrix"
strategy:
matrix:
runtime: [
# https://hexdocs.pm/elixir/compatibility-and-deprecations.html
# 1.13.x
{ elixir: 1.13.x, otp: 22.3.x },
{ elixir: 1.13.x, otp: 23.3.x },
{ elixir: 1.13.x, otp: 24.3.x },
{ elixir: 1.13.x, otp: 25.3.x },
# 1.14.x
{ elixir: 1.14.x, otp: 23.3.x },
{ elixir: 1.14.x, otp: 24.3.x },
{ elixir: 1.14.x, otp: 25.3.x },
# 1.15.x
{ elixir: 1.15.x, otp: 24.3.x },
{ elixir: 1.15.x, otp: 25.3.x },
{ elixir: 1.15.x, otp: 26.2.x },
# 1.16.x
{ elixir: 1.16.x, otp: 24.3.x },
{ elixir: 1.16.x, otp: 25.3.x },
{ elixir: 1.16.x, otp: 26.2.x },
# 1.17.x
{ elixir: 1.17.x, otp: 25.3.x },
{ elixir: 1.17.x, otp: 26.2.x },
{ elixir: 1.17.x, otp: 27.2.x },
# 1.18.x
{ elixir: 1.18.x, otp: 25.3.x },
{ elixir: 1.18.x, otp: 26.2.x },
{ elixir: 1.18.x, otp: 27.2.x },
]
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Set up Elixir
id: beam
uses: erlef/setup-beam@v1
with:
otp-version: ${{ matrix.runtime.elixir }}
elixir-version: ${{ matrix.runtime.otp }}
- name: Restore dependencies cache
id: mix_cache
uses: actions/cache@v4
with:
path: |
deps
_build
key: mix-${{ runner.os }}-${{ steps.beam.outputs.otp-version }}-${{ steps.beam.outputs.elixir-version }}-${{ hashFiles('**/mix.lock') }}
restore-keys: mix-${{ runner.os }}-${{ steps.beam.outputs.otp-version }}-${{ steps.beam.outputs.elixir-version }}-
- name: Install Dependencies
run: |
mix deps.get
mix deps.compile
- name: Run test
run: mix test
# run extra steps on latest supported
extra_checks:
name: Lint and check on latest runtime
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Set up Elixir
id: beam
uses: erlef/setup-beam@v1
with:
otp-version: $LATEST_OTP
elixir-version: $LATEST_ELIXIR
- name: Restore dependencies cache
id: mix_cache
uses: actions/cache@v4
with:
path: |
deps
_build
key: mix-${{ runner.os }}-${{ steps.beam.outputs.otp-version }}-${{ steps.beam.outputs.elixir-version }}-${{ hashFiles('**/mix.lock') }}
restore-keys: mix-${{ runner.os }}-${{ steps.beam.outputs.otp-version }}-${{ steps.beam.outputs.elixir-version }}-
- name: Install Dependencies
run: |
mix deps.get
mix deps.compile
MIX_ENV=dev mix deps.compile
- name: Restore PLT cache
id: plt_cache
uses: actions/cache/restore@v4
with:
path: priv/plts
key: plt-${{ runner.os }}-${{ steps.beam.outputs.otp-version }}-${{ steps.beam.outputs.elixir-version }}-${{ hashFiles('**/mix.lock') }}
restore-keys: plt-${{ runner.os }}-${{ steps.beam.outputs.otp-version }}-${{ steps.beam.outputs.elixir-version }}-
- name: Create PLTs
if: steps.plt_cache.outputs.cache-hit != 'true'
run: MIX_ENV=dev mix dialyzer --plt
# By default, the GitHub Cache action will only save the cache if all
# steps in the job succeed, so we separate the cache restore and save
# steps in case running dialyzer fails.
- name: Save PLT cache
id: plt_cache_save
uses: actions/cache/save@v4
if: steps.plt_cache.outputs.cache-hit != 'true'
with:
key: plt-${{ runner.os }}-${{ steps.beam.outputs.otp-version }}-${{ steps.beam.outputs.elixir-version }}-${{ hashFiles('**/mix.lock') }}
path: priv/plts
- name: Run format
run: mix format --check-formatted
- name: Run credo
run: mix credo
- name: Run test
run: mix test
# dialyzer takes longer to run, let others fail faster.
- name: Run dialyzer
run: MIX_ENV=dev mix dialyzer --format github
validate_unlocked:
name: Validate Code With Unlocked Dependencies
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Set up Elixir
id: beam
uses: erlef/setup-beam@v1
with:
otp-version: $LATEST_OTP
elixir-version: $LATEST_ELIXIR
- name: Restore dependencies cache
id: mix_cache
uses: actions/cache@v4
with:
path: |
deps
_build
key: mix-${{ runner.os }}-${{ steps.beam.outputs.otp-version }}-${{ steps.beam.outputs.elixir-version }}-${{ hashFiles('**/mix.lock') }}
restore-keys: mix-${{ runner.os }}-${{ steps.beam.outputs.otp-version }}-${{ steps.beam.outputs.elixir-version }}-
- name: Install Dependencies
run: |
mix deps.unlock --all
mix deps.get
mix deps.compile
- name: Run test
run: mix test