Skip to content
This repository has been archived by the owner on May 5, 2022. It is now read-only.

NFIBrokerage/harness_dotfiles

Repository files navigation

This harness package is deprecated. The files generated by this package are now generated in each other package such as harness_read_model instead. See #9, and see the CHANGELOG in each other package for upgrade instructions.

HarnessDotfiles

Actions CI

A harness package for common dotfiles

This is a deprecated harness package we used to use to store common dotfiles like ASDF's .tool-versions file and coveralls configuration. We ended up moving each of these configurations into more specific harness packages because we wanting to control Elixir/Erlang versions on a per package level instead of having "one blessed Elixir/Erlang combination to rule them all." This package may serve as a pretty minimalistic example of a package to get you going.

The lib/harness_dotfiles.ex fulfills the Harness.Pkg behavior and serves as the entrypoint. The templates/ directory contains the generated files in EEx format (despite not having a .eex extension). This package also has a fixture/ that is checked in CI to make sure we don't break consumers of the package when pushing updates.

As a bit of a side-note, we like using NimbleOptions with harness packages because it makes it easy to document and validate options.