commit 3707f95281d0fd6555562a1cce3b0a0a0ceb52f8 parent 8122b57f77d8b61fefd37f5dd1f297d6a39a64a8 Author: Erik Loualiche <eloualic@umn.edu> Date: Fri, 6 Feb 2026 17:59:43 -0600 Fix documentation build and add release process guidelines - Add nickel_eval_file_native to public API docs - Add release process section to CLAUDE.md requiring CI to pass before tagging Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> Diffstat:
| M | CLAUDE.md | | | 40 | ++++++++++++++++++++++++++++++++++++++++ |
| M | docs/src/lib/public.md | | | 1 | + |
2 files changed, 41 insertions(+), 0 deletions(-)
diff --git a/CLAUDE.md b/CLAUDE.md @@ -79,6 +79,46 @@ cargo test julia --project=. -e 'using Pkg; Pkg.test()' ``` +## Release Process + +**Before tagging a new version, ALL CI workflows must pass:** + +1. Run tests locally: `julia --project=. -e 'using Pkg; Pkg.test()'` +2. Push changes to main +3. Wait for CI to complete and verify all workflows pass (both CI and Documentation) +4. Only then tag and register the new version + +```bash +# Check CI status before tagging +gh run list --repo LouLouLibs/NickelEval --limit 5 + +# All workflows should show "success" before proceeding with: +git tag -a vX.Y.Z -m "vX.Y.Z: Description" +git push origin vX.Y.Z +``` + +### Version Bumping Checklist + +1. Update `version` in `Project.toml` +2. Update `## Current Version` in `TODO.md` +3. Commit these changes +4. Wait for CI to pass +5. Tag the release +6. Update loulouJL registry with correct tree SHA + +### Documentation Requirements + +Any new exported function must be added to `docs/src/lib/public.md` in the appropriate section to avoid documentation build failures. + +### Registry (loulouJL) + +Location: `/Users/loulou/Dropbox/projects_code/julia_packages/loulouJL/N/NickelEval/` + +After tagging, update `Versions.toml` with: +```bash +git rev-parse vX.Y.Z^{tree} # Get tree SHA +``` + ## Binary Protocol Specification The FFI uses a binary protocol for native type encoding: diff --git a/docs/src/lib/public.md b/docs/src/lib/public.md @@ -24,6 +24,7 @@ nickel_to_yaml check_ffi_available nickel_eval_ffi nickel_eval_native +nickel_eval_file_native ``` ## String Macro