Skip to content

Latest commit

 

History

History
21 lines (17 loc) · 1.08 KB

RELEASE.md

File metadata and controls

21 lines (17 loc) · 1.08 KB
Raw

How to release

Because we use RustlerPrecompiled, releasing is a bit more involved than it would be otherwise.

  1. Open a PR with any changes needed for the release.
  • This must include at least updating the version in mix.exs and any other files that reference it, like README.md. It must also include updating CHANGELOG.md to reflect the release.
  1. Once the PR is merged, cut a GitHub release with information from the changelog and tag the commit with the version number.
  2. This will kick off the "Build precompiled NIFs" GitHub Action. Wait for this to complete. It usually takes around 40-60 minutes.
  3. While the NIFs are compiling, ensure you have the latest version of main and don't have any intermediate builds by running rm -rf native/ex_tokenizers/target.
  4. Once the NIFs are built, use mix rustler_precompiled.download Tokenizers.Native --all --print to download generate the checksum file.
  5. Run mix hex.publish.
  6. Bump the version in the mix.exs and add the -dev flag to it.