Add doctor and remove matrix runs #42
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
| on: push | |
| name: Checks | |
| # Sets the ENV `MIX_ENV` to `test` for running tests | |
| env: | |
| MIX_ENV: test | |
| permissions: | |
| contents: read | |
| jobs: | |
| ensure_code_consistency: | |
| runs-on: ubuntu-latest | |
| name: Ensure code consistency | |
| steps: | |
| # Step: Setup Elixir + Erlang image as the base. | |
| - name: Set up Elixir | |
| uses: erlef/setup-beam@v1 | |
| with: | |
| otp-version: "26.2.3" | |
| elixir-version: "1.16.2" | |
| # Step: Check out the code. | |
| - name: Checkout code | |
| uses: actions/checkout@v4 | |
| # Step: Define how to cache deps. Restores existing cache if present. | |
| - name: Cache deps | |
| id: cache-deps | |
| 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: Define how to cache the `_build` directory. After the first run, | |
| # this speeds up tests runs a lot. This includes not re-compiling our | |
| # project's downloaded deps every run. | |
| - 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: Conditionally bust the cache when job is re-run. Sometimes, we | |
| # may have issues with incremental builds that are fixed by doing a full | |
| # recompile. In order to not waste dev time on such trivial issues (while | |
| # also reaping the time savings of incremental builds for *most* | |
| # day-to-day development), force a full recompile only on builds that are | |
| # retried. | |
| - name: Clean to rule out incremental build as a source of flakiness | |
| if: github.run_attempt != '1' | |
| run: | | |
| mix deps.clean --all | |
| mix clean | |
| shell: sh | |
| # 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. | |
| - name: Compiles without warnings | |
| run: mix compile --warnings-as-errors | |
| # Step: Check that the code has already been formatted. | |
| - name: Check Formatting | |
| run: mix format --check-formatted | |
| # Step: Check that the code complies with the credo rules. | |
| - name: Check Credo | |
| run: mix credo -A | |
| # Step: Check that the documentation complies with the doctor rules. | |
| - name: Check Doctor | |
| run: mix doctor | |
| test: | |
| # Set up a Postgres DB service. By default, Phoenix applications | |
| # use Postgres. This creates a database for running tests. | |
| # Additional services can be defined here if required. | |
| services: | |
| db: | |
| image: postgres:16 | |
| ports: | |
| - 5432:5432 | |
| env: | |
| POSTGRES_PASSWORD: postgres | |
| POSTGRES_USER: postgres | |
| POSTGRES_DB: playground_test | |
| options: >- | |
| --health-cmd pg_isready | |
| --health-interval 10s | |
| --health-timeout 5s | |
| --health-retries 5 | |
| runs-on: ubuntu-latest | |
| name: Unit Tests | |
| steps: | |
| # Step: Setup Elixir + Erlang image as the base. | |
| - name: Set up Elixir | |
| uses: erlef/setup-beam@v1 | |
| with: | |
| otp-version: "26.2.3" | |
| elixir-version: "1.16.2" | |
| # Step: Check out the code. | |
| - name: Checkout code | |
| uses: actions/checkout@v4 | |
| # Step: Define how to cache deps. Restores existing cache if present. | |
| - name: Cache deps | |
| id: cache-deps | |
| 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: Define how to cache the `_build` directory. After the first run, | |
| # this speeds up tests runs a lot. This includes not re-compiling our | |
| # project's downloaded deps every run. | |
| - 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: Conditionally bust the cache when job is re-run. Sometimes, we | |
| # may have issues with incremental builds that are fixed by doing a full | |
| # recompile. In order to not waste dev time on such trivial issues (while | |
| # also reaping the time savings of incremental builds for *most* | |
| # day-to-day development), force a full recompile only on builds that are | |
| # retried. | |
| - name: Clean to rule out incremental build as a source of flakiness | |
| if: github.run_attempt != '1' | |
| run: | | |
| mix deps.clean --all | |
| mix clean | |
| shell: sh | |
| # 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. | |
| - name: Compiles without warnings | |
| run: mix compile --warnings-as-errors | |
| # Step: Setup the database for the tests. | |
| - name: Setup db | |
| run: mix ecto.setup | |
| # Step: Execute the tests. | |
| - name: Run tests | |
| run: mix test |