Add rustler precompiled

Author: emilsoman

.github/workflows/release.yml

@@ -2,13 +2,6 @@ name: Build precompiled NIFs
 
 on:
   push:
-    branches:
-      - main
-    paths:
-      # Just run on main branch if "native" path changed. Tags will always run.
-      - "native/**"
-      # Also run in case there is any changes to this file.
-      - ".github/workflows/release.yml"
     tags:
       - "*"
 
@@ -81,7 +74,7 @@ jobs:
           use-cross: ${{ matrix.job.use-cross }}
 
       - name: Artifact upload
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: ${{ steps.build-crate.outputs.file-name }}
           path: ${{ steps.build-crate.outputs.file-path }}

RELEASE.md

@@ -0,0 +1,14 @@
+# How to release
+
+Because we use
+[`RustlerPrecompiled`](https://hexdocs.pm/rustler_precompiled/RustlerPrecompiled.html), releasing
+is a bit more involved than it would be otherwise.
+
+1. Cut a GitHub release 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 BamlElixir.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.

mix.exs

@@ -8,7 +8,7 @@ defmodule BamlElixir.MixProject do
       elixir: "~> 1.17",
       start_permanent: Mix.env() == :prod,
       deps: deps(),
-      aliases: aliases()
+      package: package()
     ]
   end
 
@@ -22,14 +22,23 @@ defmodule BamlElixir.MixProject do
   # Run "mix help deps" to learn about dependencies.
   defp deps do
     [
-      {:rustler, "~> 0.36.1", runtime: false}
+      {:rustler, "~> 0.36.1", optional: true},
+      {:rustler_precompiled, "~> 0.8"}
     ]
   end
 
-  defp aliases do
+  defp package do
     [
-      # Add any custom mix aliases here
-      "baml.generate": ["compile", "baml.generate"]
+      files: [
+        "lib",
+        "native",
+        "checksum-*.exs",
+        "mix.exs",
+        "LICENSE"
+      ],
+      licenses: ["Apache-2.0"],
+      links: %{"GitHub" => "https://github.com/emilsoman/baml_elixir"},
+      maintainers: ["Emil Soman"]
     ]
   end
 end

mix.lock

@@ -1,5 +1,7 @@
 %{
+  "castore": {:hex, :castore, "1.0.12", "053f0e32700cbec356280c0e835df425a3be4bc1e0627b714330ad9d0f05497f", [:mix], [], "hexpm", "3dca286b2186055ba0c9449b4e95b97bf1b57b47c1f2644555879e659960c224"},
   "jason": {:hex, :jason, "1.4.4", "b9226785a9aa77b6857ca22832cffa5d5011a667207eb2a0ad56adb5db443b8a", [:mix], [{:decimal, "~> 1.0 or ~> 2.0", [hex: :decimal, repo: "hexpm", optional: true]}], "hexpm", "c5eb0cab91f094599f94d55bc63409236a8ec69a21a67814529e8d5f6cc90b3b"},
   "rustler": {:hex, :rustler, "0.36.1", "2d4b1ff57ea2789a44756a40dbb5fbb73c6ee0a13d031dcba96d0a5542598a6a", [:mix], [{:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: false]}, {:toml, "~> 0.7", [hex: :toml, repo: "hexpm", optional: false]}], "hexpm", "f3fba4ad272970e0d1bc62972fc4a99809651e54a125c5242de9bad4574b2d02"},
+  "rustler_precompiled": {:hex, :rustler_precompiled, "0.8.2", "5f25cbe220a8fac3e7ad62e6f950fcdca5a5a5f8501835d2823e8c74bf4268d5", [:mix], [{:castore, "~> 0.1 or ~> 1.0", [hex: :castore, repo: "hexpm", optional: false]}, {:rustler, "~> 0.23", [hex: :rustler, repo: "hexpm", optional: true]}], "hexpm", "63d1bd5f8e23096d1ff851839923162096364bac8656a4a3c00d1fff8e83ee0a"},
   "toml": {:hex, :toml, "0.7.0", "fbcd773caa937d0c7a02c301a1feea25612720ac3fa1ccb8bfd9d30d822911de", [:mix], [], "hexpm", "0690246a2478c1defd100b0c9b89b4ea280a22be9a7b313a8a058a2408a2fa70"},
 }