Skip to content

README.md

Latest commit

 

History

History
86 lines (57 loc) · 1.46 KB

README.md

File metadata and controls

86 lines (57 loc) · 1.46 KB

Elixir CI action

Action to run multiple elixir CI commands. In order:

  • mix deps.get
  • mix compile --warnings-as-errors
  • mix format --check-formatted
  • mix deps.unlock --check-unused
  • mix credo
  • mix dialyzer
  • mix test

Inputs

mix-env

The MIX_ENV variable to run the commands in. Default: test

mix-env-test

The MIX_ENV variable to run tests in. Default: test

run-tests

Wether to run mix test or not. Default: True

tests-flags

Flags to add to append to the mix test command (e.g. --only tag or --no-start, etc.) Default: ''

working-directory

The directory to work on. Default: .

release

Wether to run mix release and upload artifact or not. Default: False

release-name

The name of the uploaded release. Default: release

release-upload

Wether to upload the artifact or not. Default: False

build-cache-key-suffix

Suffix to add to the build cache key Default: ""

plt-cache-key-suffix

Suffix to add to the plt cache key Default: ""

plt-restore-cache

If false it won't retrieve cache from other restore keys Default: "True"

compile-options

the compile options parameter Default: --warnings-as-errors

Example usage

- name: Run elixir CI
  uses: airnity/elixir-ci-action@v4
  with:
    mix-env: dev
    working-directory: "./myApp"
    release: "True"
    build-cache-key-suffix: "test"
    plt-restore-cache: "False"