This is a base project for setting up a GitHub Actions-based Elixir continuous integration (CI) system, as described on our blog.
It builds on the Hashrocket post on setting up the ultimate Elixir CI, with some important tweaks:
- It runs most CI jobs in parallel so you get the fastest feedback
- It runs all actions on every commit (the jobs never "fail fast"), so you'll know all the things you need to fix on the first run
- It pulls out a lot of boilerplate for setting up and caching the project into a shared "composite" action
- It clears the build cache when a human asks for a retry, neatly resolving mistrust of build caches
- It configures Dependabot to get PRs to update the dependencies
- It runs slow tests in a nightly integration test job, rather than on every commit
The independent CI jobs it sets up are:
- Test (via ExUnit)
- Dialyzer
- Formatting, checking for compile-time dependencies between modules, and Credo (these could be separate tasks, but in my experience they run fast enough even on large projects that it's not worth breaking them apart)
We cache as much as we can between the jobs. Thus, for instance, your first run of Dialyzer will be sloooooooow, but subsequent ones should be quite fast. Do note that running the tasks in parallel, rather than sequentially, means you're trading CI time for dev productivity. This is the right tradeoff for most teams, but your mileage may vary.
The important bits here for including in your project are:
.github/**/*.formatter.exsmix.exs, or at least the dependencies, Dialyzer config, and ExCoveralls config there- Optional:
.dialyzer_ignore.exs(otherwise you'll need to remove that line from mix.exs)