NEURON 8.2.0 release

[alexsavulescu]

Action items

Pre-release

• Look out for ModelDB regressions by analyzing nrn-modeldb-ci last version vs nightly reports -> https://github.com/neuronsimulator/nrn-modeldb-ci/actions/runs/2587650025
• Create CoreNEURON release & update submodule

Sanity checks

• Create release/8.2 branch and make sure GitHub, Azure and CircleCI builds pass
• Run nrn-build-ci for the respective Azure build; see Azure drop guide
• Activate ReadTheDocs build for release/8.2 & make it hidden. Check docs are fine after build is done.
• Run BBP Simulation Stack & other relevant tests
• Build release wheels but WITHOUT upload (see details)

Releasing

• Update changelog directly in Changelog + cherries for 8.2.0  #1834
• Update docs/index.rst accordingly with the new .pkg and .exe links for PKG installer and Windows Installer
• Run the ReadTheDocs build again for release-8.2, make sure the build passes and inspect the Changelog page.
• Create new release+tag on GitHub via release workflow
• Create, test and upload manual artifacts (MacOS package installers, arm64/aarch64 wheels, ...)
• Publish the 8.2.0 wheels on Pypi; see wheel publishing instructions
• Once wheels are published, activate the 8.2.0 tag on ReadTheDocs
• Upload Windows installer from the wheels publishing Azure run (to get correct tag)
• Publish release on GitHub (edit https://github.com/neuronsimulator/nrn/releases/tag/8.2.0)

Post-release

• Tag master with x.(y+1).dev to mark the start of a new development cycle
• Deactivate ReadTheDocs build for release/x.y
• Let people know 🚀

ReadTheDocs sneak peek

• https://nrn.readthedocs.io/en/release-8.2

Commits going into 8.2.0

Since 8.1.0, with:

git log --pretty=format:"%h : %s" 8.1.0..release/8.2

we get:

156b9de : Update docs/index.rst installer versions
16a9d7d : Update changelog.md for 8.2.0
285d7f4 : Escape special characters (#1862)
50688ad : forum link in docs (#1884)
da98221 : CoreNEURON 8.2 branch
a377a94 : Add PR numbers and note about Python 3.6
1abdcc5 : Start release notes for 8.2.0.
2c3a21d : docs README - point to CMake Option description (#1852)
31862a2 : hack hocdomain.py for Sphinx 5.0.1 (#1851)
6e4f8cb : Use mallinfo if mallinfo2 is unavailable (#1844)
0c5353a : Remove some K&R syntax. (#1846)
8795082 : Azure CI: add PR comment with artifacts URL (#1845)
1157a42 : Configure sanitizers in CMake, fix issues (#1842)
8a296fa : release CI - use ubuntu latest (#1843)
80357bc : Remove some PtrList and List use outside context of IV (#1815)
1a94b30 : Workaround for #1840. (#1841)
fe11246 : Update coreneuron submodule (#1835)
4873aed : Eliminate ForAllSections macro so clang-format succeeds. (#1836)
121d968 : mech_api.h: expose more declarations to translated MOD files (#1825)
7b2a888 : Remove ivos/table.h and replace usage with std::map(#1832)
5249614 : Remove unused files from IVOS (#1830)
571ab16 : syntax highlight, more links, Python3 fix (#1826)
78c3731 : somehow lost an indent; also 1 -> True (#1828)
8ffc682 : IntFire1 example (#1827)
b761571 : Update CoreNEURON (#1824)
c127b54 : test_netcvode.py: increase comparison tolerances. (#1822)
5988ffe : Update CoreNEURON submodule (#1821)
9455cf7 : NEURON course exercise sets (#1735)
ac03c29 : Increase coverage of src/nrncvode/netcvode.cpp (#1752)
27fdf9a : Fix heap buffer overflow. (#1817)
a8e9dcc : oc_ansi.h: add some definitions used in mods (ModedlDB & BBP) (#1811)
fcd609e : publications using NEURON; progress toward #1728 (#1819)
7bb6808 : Azure macOS CI: make sure libomp is not present (#1818)
3f2f83d : Fix warnings for gcc version 11.2.0 (#1805)
3cc83cf : CYGWIN in removed_features.rst (#1807)
03d2ef7 : Remove CYGWIN (#1802)
2f90f37 : Remove some deprecated features (#1806)
4dbec4b : ninja works for mingw build (#1803)
70851a7 : Random123 as a submodule (#1796)
4789dcd : Check if including mpi headers are required (#1772)
0dda020 : Refactor nrnivmodl.in (#1781)
60f147a : MPI dynamic load, dlopen with name of already loaded libmpi. (#1780)
26f982d : Test for Update mod2c: fix for POINTER variables in PROCEDURE (#1791)
e0b74fc : Corrected cvode attribute (#1787)
746c3d7 : get c91662.CNG.swc from neuronsimulator/resources (#1790)
548348a : Fix typo in binwrapper for wheels and update submodules (#1779)
942e3d8 : clang-format: MKDLL* macros are statements, update git-blame-ignore-revs (#1753)
ab22155 : docs: fetch insecurely from neuromorpho.org (#1785)
991863f : Add NRN_VERSION_* test macros for VERBATIM. (#1762)
83c9304 : Update release template following #1761 (#1774)
415a69c : doc landing page that looks like a homepage and does not simply repeat the sidebar (#1761)
e403c27 : NeuronTestHelper: CORENEURON option, re-enable tests (#1768)
bb838bc : Fix #335: Return proper exit code in hoc execution (#1633)
a343dfa : Improve C/C++ formatting check (#1759)
8387a7b : Hide output of internal git command in cmake (#1756)
710d2ca : Update test models for MOD to C++ translation support (#1747)
a527c23 : nrnrandom.h: declare nrnrandom for mechanisms. (#1755)
331e750 : Bump coding-conventions submodule to fefb5c4f2a (#1751)
310551f : nrnivmodl: pass -incflags to CoreNEURON. (#1750)
18c7bb4 : docs requirements: jinja2 go upstream (#1749)
4d9a025 : clang-format: one-off for extra files. (#1748)
013b69a : Check C/C++ code formatting in CI. (#1732)
cd7274c : coreneuron: master. (#1742)
380456a : update release issue template (#1741)
b59e6de : Allow multiple BEFORE/AFTER blocks of same type in a mod file. (#1722)
30b9eac : Improve documentation targets. (#1725)
e7633ff : Added opt-in black pre-commit hook (#1738)
af911ad : Enable only selected builds on circleci (#1739)
c5d0fc9 : Check CMake code formatting in CI (#1730)
d65a708 : Check Python code formatting in CI (#1729)
513d45c : drop Python 3.6 support (#1733)
4d29468 : NEURON 8.1.0 Changelog (#1724)
d141b74 : ban [email protected] as it's buggy (#1731)
6d82be0 : docs: NetStim random guide; also fix to toctree (#1727)
d0f38d5 : UndefinedBehaviourSanitizer fixes (#1479)
6f666ac : Disallow STATE variables being GLOBAL (#1723)

[alexsavulescu]

all done 🚀