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

Remove pbkdf2 optional dependency, update instructions #25

Merged
merged 1 commit into from
Jun 5, 2021

Conversation

danielberkompas
Copy link
Owner

@danielberkompas danielberkompas commented Jun 5, 2021

It isn't possible to publish a package to Hex.pm with a dependency on a Github fork which is not also hosted on Hex.pm. The current version of pbkdf2 is not compatible with Erlang 24. To use it, you'll need a forked version, see #24.

For this reason, I needed to make the pbkdf2 a :dev, :test dependency instead of an :optional dependency for cloak_ecto. If you add it to your mix dependencies in your project, cloak_ecto should still detect it; it shouldn't need to be listed as an optional dependency.

I updated the instructions in the module doc for Cloak.Ecto.PBKDF2 to reflect this information.

It isn't possible to publish a package to Hex.pm with a dependency on a
Github fork which is not also hosted on Hex.pm. The current version of
`pbkdf2` is not compatible with Erlang 24. To use it, you'll need a
forked version, see #24.

For this reason, I needed to make the `pbkdf2` a `:dev, :test`
dependency instead of an `:optional` dependency for `cloak_ecto`. If you
add it to your mix dependencies in your project, `cloak_ecto` should
still detect it; it shouldn't need to be listed as an optional
dependency.
@danielberkompas danielberkompas merged commit 63218c5 into master Jun 5, 2021
@danielberkompas danielberkompas deleted the pbkdf2-otp-24 branch June 5, 2021 21:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant