Advanced Configuration

minimum_otp_vsn

Purpose: Minimum OTP version required

Type: string()

Example:

{minimum_otp_vsn, "24"}.

Also Supports Regex:

{minimum_otp_vsn, "24|25"}.

Purpose: Additional artifacts to verify after compilation

Type: [File :: string()]

Variables: {{profile}}, {{priv_dir}}

Example:

{artifacts, [
    "priv/my_nif.so",
    "priv/{{profile}}/custom_artifact"
]}.

Purpose: Plugins for this project only (not global)

Type: Same as deps

Example:

{project_plugins, [
    rebar3_hex,
    {rebar3_custom, {git, "...", {tag, "1.0.0"}}}
]}.

Purpose: Global plugins

Type: Same as deps

Example:

{plugins, [
    rebar3_proper,
    rebar3_ex_doc
]}.

Purpose: External file for .app.src variable substitution

Type: string()

Example:

{app_vars_file, "config/app.vars"}.

File Contents (config/app.vars):

{copyright, "Copyright (c) 2024 Company"}.
{build_date, "2024-01-15"}.

Purpose: Number of parallel compilation workers

Type: pos_integer()

Default: Number of CPU cores

Example:

{jobs, 4}.

Purpose: Leex/Yecc compiler options

Type: [term()]

Example:

{xrl_opts, [{includefile, "custom.hrl"}]}.
{yrl_opts, [{includefile, "parser.hrl"}]}.

Purpose: SNMP MIB compiler options

Type: [term()]

Example:

{mib_opts, [
    {i, ["priv/mibs"]},
    {outdir, "priv/mibs"}
]}.

Purpose: Rebar3 shell configuration

Type: [{Key, Value}]

Example:

{shell, [
    {config, "config/sys.config"},
    {apps, [my_app]},
    {script_file, "scripts/shell.escript"}
]}.