search

dnsimple / erldns

DNS server, in Erlang.
MIT License
402 stars 98 forks source link

Fix rebar3 mentions in the README #158

Closed whatyouhide closed 2 weeks ago

whatyouhide commented 3 weeks ago

There is no rebar3 executable in this repository, nor is one installed by any of the commands in the README. Some of us use the rebar3 executable that is installed by Hex, others use the asdf plugin, and this section from Rebar's official website even says:

While the script version of Rebar3 is portable and usable from anywhere, it is advised not to keep it in your project’s repository and to install it globally, for your entire system. Regardless of which recent Erlang version you have installed, Rebar3 should be fully compatible with it.

So I'd say we instruct folks to do rebar3 instead of ./rebar3. Thoughts?

weppos commented 3 weeks ago

nor is one installed by any of the commands in the README.

Actually, it is installed by make the first time you will call any task that need rebar (vs calling rebar directly). https://github.com/dnsimple/erldns/blob/5ce0b25acdee06b7d6bf4387a5ac680ceb39a9bb/Makefile#L1-L7

Perhaps this part should be made more explicitly documented in our repo.

I suspect rebar should work with both local and global setups, whereas the opposite is not true (aka ./rebar). Correct?

whatyouhide commented 2 weeks ago

From this line

REBAR:=$(shell which rebar3 || echo ./rebar3)

then yeah it looks like a globally-installed rebar3 would take precedence over the locally-installed, which is what we want I think. I'll rework this in a different PR 🙃