Add comments and reorganized some html #23
Workflow file for this run
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: Elixir CI | |
| on: | |
| push: | |
| branches: ["main"] | |
| pull_request: | |
| branches: ["main"] | |
| env: | |
| MIX_ENV: test | |
| permissions: | |
| contents: read | |
| jobs: | |
| analysis: | |
| runs-on: ubuntu-latest | |
| name: Static analysis for ${{matrix.otp}} / Elixir ${{matrix.elixir}} | |
| strategy: | |
| # Specify the OTP and Elixir versions to use when building | |
| # and running the workflow steps. | |
| matrix: | |
| otp: ["26.0"] # Define the OTP version [required] | |
| elixir: ["1.16"] # Define the elixir version [required] | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Set up Elixir | |
| id: beam | |
| uses: erlef/setup-beam@v1 | |
| with: | |
| otp-version: ${{matrix.otp}} | |
| elixir-version: ${{matrix.elixir}} | |
| - name: Restore dependencies cache | |
| uses: actions/cache@v4 | |
| 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 }}- | |
| # Step: Download project dependencies. If unchanged, uses | |
| # the cached version. | |
| - name: Install dependencies | |
| run: mix deps.get | |
| # Cache key based on Erlang/Elixir version and the mix.lock hash | |
| - name: Restore PLT cache | |
| id: plt_cache | |
| uses: actions/cache/restore@v3 | |
| with: | |
| 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 }}- | |
| path: | | |
| priv/plts | |
| # Create PLTs if no cache was found | |
| - name: Create PLTs | |
| if: steps.plt_cache.outputs.cache-hit != 'true' | |
| run: 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@v3 | |
| 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 dialyzer | |
| run: mix dialyzer --format github | |
| test: | |
| runs-on: ubuntu-latest | |
| name: Test on OTP ${{matrix.otp}} / Elixir ${{matrix.elixir}} | |
| strategy: | |
| # Specify the OTP and Elixir versions to use when building | |
| # and running the workflow steps. | |
| matrix: | |
| otp: ["26.0"] # Define the OTP version [required] | |
| elixir: ["1.16"] # Define the elixir version [required] | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Set up Elixir | |
| uses: erlef/setup-beam@v1 | |
| with: | |
| otp-version: ${{matrix.otp}} | |
| elixir-version: ${{matrix.elixir}} | |
| - name: Restore dependencies cache | |
| uses: actions/cache@v4 | |
| 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@v4 | |
| 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- | |
| # Step: Download project dependencies. If unchanged, uses | |
| # the cached version. | |
| - name: Install dependencies | |
| run: mix deps.get | |
| # Step: Compile the project treating any warnings as errors. | |
| # Customize this step if a different behavior is desired. | |
| - name: Compiles without warnings | |
| run: mix compile --warnings-as-errors | |
| # Step: Check that the checked in code has already been formatted. | |
| # This step fails if something was found unformatted. | |
| # Customize this step as desired. | |
| - name: Check Formatting | |
| run: mix format --check-formatted | |
| # Step: Execute the tests. | |
| - name: Run tests | |
| run: mix test |