chore: add license (#1) #8
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
# This workflow uses actions that are not certified by GitHub. | |
# They are provided by a third-party and are governed by | |
# separate terms of service, privacy policy, and support | |
# documentation. | |
name: Elixir CI | |
on: | |
push: | |
branches: [ "main" ] | |
pull_request: | |
branches: [ "main" ] | |
permissions: | |
contents: read | |
env: | |
MIX_ENV: test | |
jobs: | |
test: | |
name: Test (Elixir ${{ matrix.elixir }}, OTP ${{ matrix.otp }}) | |
runs-on: ubuntu-latest | |
strategy: | |
fail-fast: false | |
matrix: | |
# https://hexdocs.pm/elixir/compatibility-and-deprecations.html#compatibility-between-elixir-and-erlang-otp | |
include: | |
# Newest supported Elixir/Erlang pair. | |
- elixir: '1.17' | |
otp: '27.1' | |
lint: true | |
# One version before the last supported one. | |
- elixir: '1.16' | |
otp: '26.2' | |
- elixir: '1.15' | |
otp: '25.3' | |
steps: | |
- uses: actions/checkout@v4 | |
- name: Set up Elixir and Erlang | |
uses: erlef/setup-beam@61e01a43a562a89bfc54c7f9a378ff67b03e4a21 # v1.16.0 | |
with: | |
elixir-version: ${{ matrix.elixir }} | |
otp-version: ${{ matrix.otp }} | |
# Manually restore and then save, so that we can save the "_build" directory | |
# *without* the Elixir compiled code in it. | |
- name: Restore Mix dependencies cache | |
uses: actions/cache/restore@v4 | |
id: mix-deps-cache | |
with: | |
path: | | |
_build | |
deps | |
key: ${{ runner.os }}-${{ matrix.otp }}-${{ matrix.elixir }}-mix-${{ hashFiles('**/mix.lock') }} | |
restore-keys: ${{ runner.os }}-${{ matrix.otp }}-${{ matrix.elixir }}-mix- | |
- name: Install and compile Mix dependencies | |
if: steps.mix-deps-cache.outputs.cache-hit != 'true' | |
run: mix do deps.get --check-locked, deps.compile | |
- name: Save Mix dependencies cache | |
uses: actions/cache/save@v4 | |
if: steps.mix-deps-cache.outputs.cache-hit != 'true' | |
with: | |
path: | | |
_build | |
deps | |
key: ${{ steps.mix-deps-cache.outputs.cache-primary-key }} | |
- name: Check formatting | |
if: matrix.lint | |
run: mix format --check-formatted | |
- name: Check compiler warnings | |
if: matrix.lint | |
run: mix compile --warnings-as-errors | |
- name: Run tests | |
run: mix test | |
- name: Retrieve PLT Cache | |
uses: actions/cache@v4 | |
if: matrix.lint | |
id: plt-cache | |
with: | |
path: priv/plts | |
key: ${{ runner.os }}-${{ matrix.otp }}-${{ matrix.elixir }}-plts-${{ hashFiles('**/mix.lock') }} | |
restore-keys: ${{ runner.os }}-${{ matrix.otp }}-${{ matrix.elixir }}-plts- | |
- name: Create PLTs | |
if: steps.plt-cache.outputs.cache-hit != 'true' && matrix.lint | |
run: | | |
mkdir -p plts | |
mix dialyzer --plt | |
- name: Run dialyzer | |
if: matrix.lint | |
run: mix dialyzer --no-check --halt-exit-status |