Release Checklist for `v4`

SciML / NonlinearSolve.jl

High-performance and differentiation-enabled nonlinear solvers (Newton methods), bracketed rootfinding (bisection, Falsi), with sparsity and Newton-Krylov support.

https://docs.sciml.ai/NonlinearSolve/stable/

MIT License

238 stars 42 forks source link

Release Checklist for `v4` #481

Open avik-pal opened 2 weeks ago

avik-pal commented 2 weeks ago

Pre-Release Checklist

[x] Package Registrations
- [x] NonlinearSolveBase https://github.com/JuliaRegistries/General/pull/117897
- [x] BracketingNonlinearSolve https://github.com/JuliaRegistries/General/pull/118130
- [x] SimpleNonlinearSolve v2
- [x] NonlinearSolveFirstOrder
- [x] NonlinearSolveSpectralMethods
- [x] NonlinearSolveQuasiNewton
[x] NonlinearSolve uses all of the above packages
[x] Deprecate unicode APIs
[x] Pre-Conditioners: https://github.com/SciML/NonlinearSolve.jl/pull/462

Post-Release Checklist

[ ] Downstream Compat Updates
[ ] Re-enable MTK docs

ChrisRackauckas commented 1 day ago

Downstream compats:

avik-pal commented 1 day ago

In most cases, packages shouldn't see a problem, the main change was termination conditions from DiffEqBase cannot be used

Datseris commented 1 day ago

Are there any breaking changes for front-end users downstream? Or can we just bump the compat to 4 without worry?

avik-pal commented 1 day ago

@Datseris if you were interacting with NonlinearSolve without changing the termination_condition kwarg, it should be safe to bump. https://docs.sciml.ai/NonlinearSolve/dev/release_notes/#Oct-'24 has more details