Installation
Add :expublish
to your dev dependencies in mix.exs
:
{:expublish, "~> 2.3", only: [:dev]}
Create a CHANGELOG.md
in the root folder of your project. It must contain a placeholder:
<!-- %% CHANGELOG_ENTRIES %% -->
Do not keep track of the release file. Put the following line in your .gitignore
:
RELEASE.md
The file is deleted after every successful release.
Note on hex authentication
Regardless of publishing to hex.pm or a self-hosted hex repository,
the shell environment where mix expublish
is being executed must authenticate for
the publishing step to succeed.
While publishing to hex.pm usually requires a valid HEX_API_TOKEN
to be defined
in the current environment, self-hosted repositories can use a range of various authentication methods.
Check the hex documentation on publishing and self-hosting to find out more.