Update README.md #5
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
| name: CI | |
| on: | |
| pull_request: | |
| branches: | |
| - main | |
| push: | |
| branches: | |
| - main | |
| env: | |
| MIX_ENV: test | |
| jobs: | |
| setup: | |
| name: Setup | |
| runs-on: ubuntu-latest | |
| outputs: | |
| SHORT_SHA: ${{ steps.short-sha.outputs.short_sha }} | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@v4 | |
| - name: Setup BEAM | |
| uses: erlef/setup-beam@v1 | |
| with: | |
| elixir-version: 1.16.0-otp-26 | |
| otp-version: 26.2.1 | |
| - name: Cache | |
| uses: actions/cache@v4 | |
| with: | |
| path: | | |
| _build | |
| deps | |
| key: | | |
| explain-versions-${{ hashFiles('.tool-versions') }}-${{ hashFiles('mix.lock') }}-2024-19-04 | |
| restore-keys: | | |
| explain-versions-${{ hashFiles('.tool-versions') }}-${{ hashFiles('mix.lock') }}-2024-19-04 | |
| - name: Install Elixir dependencies | |
| run: mix do deps.get, compile --warnings-as-errors | |
| test: | |
| name: Test | |
| needs: setup | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@v4 | |
| - name: Setup BEAM | |
| uses: erlef/setup-beam@v1 | |
| with: | |
| elixir-version: 1.16.0-otp-26 | |
| otp-version: 26.2.1 | |
| - name: Cache | |
| uses: actions/cache@v4 | |
| with: | |
| path: | | |
| _build | |
| deps | |
| key: | | |
| explain-versions-${{ hashFiles('.tool-versions') }}-${{ hashFiles('mix.lock') }}-2024-19-04 | |
| restore-keys: | | |
| explain-versions-${{ hashFiles('.tool-versions') }}-${{ hashFiles('mix.lock') }}-2024-19-04 | |
| - name: Install Elixir dependencies | |
| run: mix do deps.get, compile --warnings-as-errors | |
| - name: Run tests | |
| run: mix test --warnings-as-errors | |
| analysis: | |
| name: Static Analysis | |
| needs: setup | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@v4 | |
| - name: Setup BEAM | |
| id: beam | |
| uses: erlef/setup-beam@v1 | |
| with: | |
| elixir-version: 1.16.0-otp-26 | |
| otp-version: 26.2.1 | |
| - name: Cache | |
| uses: actions/cache@v4 | |
| with: | |
| path: | | |
| _build | |
| deps | |
| key: | | |
| explain-versions-${{ hashFiles('.tool-versions') }}-${{ hashFiles('mix.lock') }}-2024-19-04 | |
| restore-keys: | | |
| explain-versions-${{ hashFiles('.tool-versions') }}-${{ hashFiles('mix.lock') }}-2024-19-04 | |
| - name: Install Elixir dependencies | |
| run: mix do deps.get, compile --warnings-as-errors | |
| - name: Credo | |
| run: mix credo | |
| - name: Formatted | |
| run: mix format --check-formatted | |
| - name: Restore PLT cache | |
| uses: actions/cache@v4 | |
| id: plt_cache | |
| with: | |
| key: plt-${{ runner.os }}-${{ steps.beam.outputs.otp-version }}-${{ steps.beam.outputs.elixir-version }}-${{ hashFiles('**/mix.lock') }}-${{ hashFiles('**/*.ex') }} | |
| restore-keys: | | |
| plt-${{ runner.os }}-${{ steps.beam.outputs.otp-version }}-${{ steps.beam.outputs.elixir-version }}-${{ hashFiles('**/mix.lock') }}-${{ hashFiles('**/*.ex') }} | |
| plt-${{ runner.os }}-${{ steps.beam.outputs.otp-version }}-${{ steps.beam.outputs.elixir-version }}-${{ hashFiles('**/mix.lock') }}- | |
| plt-${{ runner.os }}-${{ steps.beam.outputs.otp-version }}-${{ steps.beam.outputs.elixir-version }}- | |
| plt-${{ runner.os }}-${{ steps.beam.outputs.otp-version }}- | |
| path: priv/plts | |
| - name: Create PLTs | |
| if: steps.plt_cache.outputs.cache-hit != 'true' || github.run_attempt != '1' | |
| run: mix dialyzer --plt | |
| - name: Run Dialyzer | |
| run: mix dialyzer --format github |