View Source Divo.File (divo v2.0.0)

Constructs the ad hoc docker-compose file used by Divo to run docker dependency services based on config in the app environment (Mix.env()) file.

Link to this section Summary

Functions

Passes through the file name when the compose file is pre-existing and supplied via file system path. Builds and writes a dynamic compose file to a temp directory before returning the path to that temp file if file does not exist.

Returns the name of the compose file to run, either as a pass-through from an existing compose file or the path of the file dynamically created by Divo.

Link to this section Functions

@spec ensure_file(String.t() | [tuple()] | map()) :: String.t()

Passes through the file name when the compose file is pre-existing and supplied via file system path. Builds and writes a dynamic compose file to a temp directory before returning the path to that temp file if file does not exist.

@spec file_name() :: String.t()

Returns the name of the compose file to run, either as a pass-through from an existing compose file or the path of the file dynamically created by Divo.