Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix rebar3 mentions in the README #158

Closed
wants to merge 1 commit into from
Closed

Conversation

whatyouhide
Copy link
Contributor

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?

@whatyouhide whatyouhide requested a review from weppos October 6, 2024 13:20
### Launch directly:

```bash
overmind start
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think we want to mention overmind, which seems to be a tool that requires auth and whatnot. Am I missing something?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We use Overmind as process management across most of our apps.
https://github.com/DarthSim/overmind

It is reading the Procfile, which is a sort of standard process definition
https://github.com/dnsimple/erldns/blob/main/Procfile

It's a sort of convention. However, we generally wrap it behind a convenient make call:

make start

I imagine we have not cleaned it up for Erlang projects yet. Do you have an alternative recommendation on how to start the app, that could work consistently across the various apps?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No wonder I was confused... I thought this was about this overmind CLI tool. 🤦

Ok, makes sense then. Yep, I’m familiar with Procfiles and all. I'll make sure that we have make start here and maybe a note about overmind then. I'll close this PR out.

@weppos weppos added the task Task to be performed label Oct 7, 2024
@weppos
Copy link
Member

weppos commented Oct 7, 2024

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).

erldns/Makefile

Lines 1 to 7 in 5ce0b25

REBAR:=$(shell which rebar3 || echo ./rebar3)
REBAR_URL:="https://s3.amazonaws.com/rebar3/rebar3"
all: clean build
$(REBAR):
curl -o rebar3 $(REBAR_URL) && chmod +x rebar3

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
Copy link
Contributor Author

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 🙃

@whatyouhide whatyouhide closed this Oct 7, 2024
@whatyouhide whatyouhide deleted the al/rebar3-readme branch October 7, 2024 18:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
task Task to be performed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants