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

rebar3 Integration Docs are Very Outdated #52

Closed
i-am-linja opened this issue Aug 31, 2024 · 2 comments
Closed

rebar3 Integration Docs are Very Outdated #52

i-am-linja opened this issue Aug 31, 2024 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@i-am-linja
Copy link

Problem

The rebar3 integration page of the docs say there is a current upstreaming effort, but this effort was merged over half a year ago. Everything that follows is in the same subsection, so I have no way to know what the actual situation is.

Solution

The docs should list the rebar3 plugins required by the current version of ELP, and how to declare them.

Notes

Does the current rebar3 integration also automatically fetch ELP itself? Or is directly downloading a binary still the best way to source it?

@i-am-linja i-am-linja added the bug Something isn't working label Aug 31, 2024
@robertoaloi robertoaloi added documentation Improvements or additions to documentation and removed bug Something isn't working labels Sep 2, 2024
@robertoaloi
Copy link
Contributor

Hi @i-am-linja Good call about the documentation. The rebar3 version with built-in support for ELP was released 4 days ago. I plan to start the cleanup (including the documentation parts) soon.

You have three options for now:

  • Wait until we modify ELP to use the built-in plugin instead of relying on a third-party plugin (~1 week)
  • Use the old-style third-party plugin (not recommended, since we're getting rid of that)
  • Create a .elp.toml file in the root of your project and add a [build_info] section as explained here. For simple rebar3 projects (no macros, no rebar.config.script, no parse transforms or hooks) that should be a good enough approximation and you won't need a rebar3 integration.

You need to install ELP yourself, either from source or binary. We need to figure out a good setup flow as you suggested here.

@robertoaloi
Copy link
Contributor

ELP now requires 3.24.0 and uses the built-in manifest plugin. I updated the docs accordingly. We will need a ELP release for this to have an effect.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants