Skip to content

Commit c3875b0

Browse files
committed
Document release tag safety and doc build requirements
1 parent a2c2b7f commit c3875b0

1 file changed

Lines changed: 8 additions & 1 deletion

File tree

AGENTS.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,4 +47,11 @@ Elixir → GenServer (`Runtime`/`Context`) → Zig NIFs (`quickbeam.zig`) → Qu
4747
```
4848
8. Update `checksum-QuickBEAM.Native.exs` with real hashes
4949
9. Commit and push: `git commit -am "Update precompiled NIF checksums for vX.Y.Z" && git push`
50-
10. Publish: `mix hex.publish`
50+
10. Build docs locally to verify: `QUICKBEAM_BUILD=1 mix compile && mix docs`
51+
(must build NIF from source — precompiled NIF causes OOM during doc generation)
52+
11. Publish: `mix hex.publish` (requires interactive terminal for auth)
53+
54+
**Never force-push a release tag.** The precompile workflow runs on tag push.
55+
Force-pushing re-triggers it, producing new artifacts with different checksums
56+
than what was already published to Hex. If you need to fix a release, publish
57+
a patch version instead.

0 commit comments

Comments
 (0)