Release Checklist for v4

[avik-pal]

Pre-Release Checklist

• Package Registrations
  • NonlinearSolveBase New package: NonlinearSolveBase v1.0.0 JuliaRegistries/General#117897
  • BracketingNonlinearSolve New package: BracketingNonlinearSolve v1.0.0 JuliaRegistries/General#118130
  • SimpleNonlinearSolve v2
  • NonlinearSolveFirstOrder
  • NonlinearSolveSpectralMethods
  • NonlinearSolveQuasiNewton
• NonlinearSolve uses all of the above packages
• Deprecate unicode APIs
• Pre-Conditioners: use LinearSolve precs setup #462

Post-Release Checklist

• Downstream Compat Updates
• Re-enable MTK docs

[ChrisRackauckas]

Downstream compats:

• CompatHelper: bump compat for SimpleNonlinearSolve to 2 for package NonlinearProblem, (keep existing compat) SciMLBenchmarks.jl#1114
• CompatHelper: bump compat for NonlinearSolve to 4 for package NonlinearProblem, (keep existing compat) SciMLBenchmarks.jl#1113
• CompatHelper: bump compat for NonlinearSolve to 4 for package IntervalNonlinearProblem, (keep existing compat) SciMLBenchmarks.jl#1112
• CompatHelper: bump compat for NonlinearSolve to 4 for package ComplicatedPDE, (keep existing compat) SciMLBenchmarks.jl#1111
• CompatHelper: bump compat for NonlinearSolve to 4 for package docs, (keep existing compat) ModelingToolkit.jl#3178
• CompatHelper: bump compat for NonlinearSolve to 4, (keep existing compat) ModelingToolkit.jl#3177
• CompatHelper: bump compat for SimpleNonlinearSolve to 2, (keep existing compat) ModelingToolkit.jl#3176
• CompatHelper: bump compat for NonlinearSolve to 4 for package docs, (keep existing compat) Catalyst.jl#1109
• CompatHelper: bump compat for NonlinearSolve to 4 for package downstream, (keep existing compat) SciMLBase.jl#843
• CompatHelper: bump compat for NonlinearSolve to 4 for package docs, (keep existing compat) SciMLDocs#254
• CompatHelper: bump compat for SimpleNonlinearSolve to 2, (keep existing compat) DelayDiffEq.jl#296
• CompatHelper: bump compat for NonlinearSolve to 4 for package docs, (keep existing compat) DeepEquilibriumNetworks.jl#169
• CompatHelper: bump compat for NonlinearSolve to 4, (keep existing compat) OrdinaryDiffEq.jl#2510
• CompatHelper: bump compat for NonlinearSolve to 4 for package docs, (keep existing compat) DiffEqDocs.jl#766
• CompatHelper: bump compat for NonlinearSolve to 4, (keep existing compat) DifferentialEquations.jl#1063
• CompatHelper: bump compat for SimpleNonlinearSolve to 2, (keep existing compat) OrdinaryDiffEq.jl#2509

[avik-pal]

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

[Datseris]

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

[avik-pal]

@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