Question 1

How do I set up rebar3_hex to publish documentation with ex_doc?

Accepted Answer

Configure your rebar.config with the ex_doc provider and set the hex doc option, as shown in the README example: add `{ex_doc, [...]}` and `{hex, [{doc, ex_doc}]}`. This ensures documentation is generated and published alongside your package on Hex.pm.

Question 2

What's the difference between rebar3 hex publish and rebar3 hex cut?

Accepted Answer

`publish` builds and pushes packages and docs directly, while `cut` adds versioning and git tag integration for more controlled releases. The README notes that `cut` provides additional functionality around versioning, making it better for workflows that involve git tagging.

Question 3

How to generate a CI key for a Hex organization with rebar3_hex?

Accepted Answer

After authenticating to the organization, use `rebar3 hex organization key hexpm:myrepo generate` to get a token, then set it as an environment variable in CI and authenticate with `rebar3 hex organization auth --key $REPO_KEY`. This secures read-only access for CI pipelines.

Question 4

rebar3_hex vs mix hex for publishing Erlang packages?

Accepted Answer

rebar3_hex is designed for Rebar3 users in Erlang projects, while mix hex is part of Elixir's Mix toolchain. If you're using Rebar3 for Erlang, rebar3_hex is the integrated choice; for Elixir projects with Mix, stick with mix hex unless Rebar3 is involved.

Question 5

Can rebar3_hex handle private Hex repositories?

Accepted Answer

Yes, it supports organizations and private repos via the organization provider. Configure the repo in rebar.config and authenticate with `rebar3 hex organization auth`, allowing package management and key generation for secure access.

Question 6

How to troubleshoot authentication failures in rebar3_hex?

Accepted Answer

Check your global or project rebar.config for correct plugin setup, ensure you're using the right password for token decryption, and verify network access to Hex.pm. The docs recommend authenticating first with `rebar3 hex user auth` before org auth.

rebar3_hex

What is rebar3_hex?

Overview

Use Cases

Best For

Related Projects

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions