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.

Sign up for GitHub

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

Jump to bottom

Is rebar3_hex required in modern/recent versions of rebar3? #333

Closed
joeljuca opened this issue Feb 29, 2024 · 7 comments · Fixed by #334
Closed

Is rebar3_hex required in modern/recent versions of rebar3? #333

joeljuca opened this issue Feb 29, 2024 · 7 comments · Fixed by #334

Comments

@joeljuca
Copy link
Contributor

While reading the docs on pkg management at rebar3.org, the subcmd hex is presented as a built-in thing instead of a separate plugin that needs to be installed before usage. I'm not very familiar with rebar3, so I'm not sure if I need to "install" rebar3_hex in my rebar3.config or if it's something that comes bundled in modern rebar3.

I'm using Erlang v25.3.2.3 and rebar3 v3.22.1, both installed through asdf.

Whichever the answer, I believe it would be great to have it stated in README.md, perhaps also describing which versions of rebar3 would require installing it manually, and which ones would bring rebar3_hex bundled in itself.
@tsloughter
Copy link
Collaborator

The rebar3_hex plugin is required for publishing packages only. Installing packages works fine without any plugin.

Agreed this should be stated clearly in the docs, it has been a source of confusion.

@paulo-ferraz-oliveira
Copy link
Collaborator

paulo-ferraz-oliveira commented Feb 29, 2024 •
edited
Loading

Yes, as stated by @tsloughter, rebar3_hex is not bundled (or installed) with rebar3, even in the latest version. Maybe a pull request to https://github.com/tsloughter/rebar3.org, to update the documentation, is the best option, at the moment.

In case it wasn't made clear, or you still have doubts, it suffices to do {deps, [rebar3_hex]} {project_plugins, [rebar3_hex]} in your rebar.config to have the plugin and its commands (under rebar3 hex) available for use.

@tsloughter
Copy link
Collaborator

Not in deps. You want {project_plugins, [rebar3_hex]}. for doing stuff like publishing a package.

@paulo-ferraz-oliveira
Copy link
Collaborator

Yeah, sorry, project_plugins 👍 I'll also fix it above.

@joeljuca
Copy link
Contributor Author

joeljuca commented Mar 4, 2024

Thanks for clarifying, @tsloughter @paulo-ferraz-oliveira!

@paulo-ferraz-oliveira
Copy link
Collaborator

Feel free to close the issue if you feel there's nothing else we can do from this repo. 👍

joeljuca added a commit to joeljuca/rebar3_hex that referenced this issue Mar 17, 2024
@joeljuca
A better TLDR of what's rebar3_hex [skip ci]
c6dff0b 
See erlef#333
@joeljuca joeljuca mentioned this issue Mar 17, 2024
Merged
@joeljuca
Copy link
Contributor Author

Thanks for clarifying, @tsloughter @paulo-ferraz-oliveira!

I avoided closing this issue to remember coming back here to submit a PR about it – and I got the time to do so today. :)

#334

starbelly pushed a commit that referenced this issue Mar 17, 2024
@joeljuca
A better TLDR of what's rebar3_hex [skip ci] (#334)
f5c97dc 
See #333
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

A better TLDR of what's rebar3_hex [skip ci] joeljuca/rebar3_hex
3 participants
@tsloughter @joeljuca @paulo-ferraz-oliveira