Remove unused stuff rom the readme 🧨 #90
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: Checks | |
# Define workflow that runs when changes are pushed to the | |
# `main` branch or pushed to a PR branch that targets the `main` | |
# branch. Change the branch name if your project uses a | |
# different name for the main branch like "master" or "production". | |
on: | |
push: | |
branches: [ "main" ] # adapt branch for project | |
pull_request: | |
branches: [ "main" ] # adapt branch for project | |
# Sets the ENV `MIX_ENV` to `test` for running tests | |
env: | |
MIX_ENV: test | |
permissions: | |
contents: read | |
jobs: | |
test: | |
runs-on: ubuntu-latest | |
name: Elixir Checks | |
steps: | |
- name: Set up Elixir | |
uses: erlef/setup-beam@v1 | |
with: | |
otp-version: 26.0.2 | |
elixir-version: 1.15.1 | |
- name: Checkout code | |
uses: actions/checkout@v3 | |
# Step: Define how to cache deps. Restores existing cache if present. | |
- name: Cache deps | |
id: cache-deps | |
uses: actions/cache@v3 | |
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@v3 | |
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 | |
- name: Compiles without warnings | |
run: mix compile --warnings-as-errors | |
- name: Check Formatting | |
run: mix format --check-formatted | |
- name: Run tests | |
run: mix test | |
- name: Credo | |
run: mix credo --strict | |
- name: Sobelow | |
run: mix sobelow --config |