setup

setup

GitHub Composite Action for installing Elixir & Beam, setting up and retrieving dependencies along with caching.

Usage

For basic usage, you don't have to specify anything! Just drop this file in your action and we will pull your elixir and erlang versions from .tool-versions, install Elixir, cache your builds and dependencies and run mix deps.get.

  - name: Setup Elixir
    uses: stordco/actions-elixir/[email protected]

But some times it's not that simple. If you are using a private package from GitHub or our private Hex organization, you'll need to specify some inputs for those credentials.

  - name: Setup Elixir
    uses: stordco/actions-elixir/[email protected]
    with:
      github-token: ${{ secrets.GH_PERSONAL_ACCESS_TOKEN }}
      hex-token: ${{ secrets.HEX_API_KEY }}

If you are not using asdf (which you really should be), you can specify the Elixir and Erlang versions with inputs as well.

  - name: Setup Elixir
    uses: stordco/actions-elixir/[email protected]
    with:
      elixir-version: "1.14"
      otp-version: "25.0"

Lastly, if things go wrong and your cache is breaking builds, you can manually increment your cache version. This will ensure no previous cache was used.

  - name: Setup Elixir
    uses: stordco/actions-elixir/[email protected]
    with:
      cache-version: v2

Inputs

name	description	default value
cache-path	A list of files, directories, and wildcard patterns to cache and restore. By default this will cache the build and deps folder allowing for faster rebuilding.	_build deps
cache-name	(Optional) The name of the cache. This is used to build the full cache key. By default this uses the job name which should suffice is most scenarios. If you have a custom naming scheme or want to share caches between different actions you can set it here. The reason we set this differently for each job is because tools will have different compile settings, like credo and dialyzer, and therefor have different files cached.
cache-version	(Optional) A version string to include in the cache key. You can change this value to bust the cache if there is an error.	v1
elixir-version	(Optional) Version range or exact version of Elixir to use. If this is not set, we attempt to read the "elixir" field from the .tool-versions file.
github-token	(Optional) Used to setup mix for pulling private packages from GitHub. This is usually secrets.GH_PERSONAL_ACCESS_TOKEN.
hex-organization	(Optional) Hex organization when authenticating. By default this will be the Stord hex organization.	stord
hex-token	(Optional) Used to setup mix for pulling private packages from the hex organization. This is usually secrets.HEX_API_KEY.
oban-fingerprint	(Optional) Public key for fetching the oban pro repository data. This is usually refered to as OBAN_KEY_FINTERPRINT in documentation.
oban-token	(Optional) Oban pro license key.
otp-version	(Optional) Version range or exact version of Erlang/OTP to use. If this is not set, we attempt to read the "erlang" field from the .tool-versions file.

Outputs

name	description
cache-hit	A boolean value to indicate an exact match was found for the cache.
elixir-version	The exact version of Elixir installed.
otp-version	The exact version of Erlang/OTP installed.