-
Notifications
You must be signed in to change notification settings - Fork 100
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
Conversation
### Launch directly: | ||
|
||
```bash | ||
overmind start |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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 Procfile
s 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.
Actually, it is installed by Lines 1 to 7 in 5ce0b25
Perhaps this part should be made more explicitly documented in our repo. I suspect |
From this line REBAR:=$(shell which rebar3 || echo ./rebar3) then yeah it looks like a globally-installed |
There is no
rebar3
executable in this repository, nor is one installed by any of the commands in the README. Some of us use therebar3
executable that is installed by Hex, others use theasdf
plugin, and this section from Rebar's official website even says:So I'd say we instruct folks to do
rebar3
instead of./rebar3
. Thoughts?