You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Activate ReadTheDocs build for release/x.y & make it hidden. Check docs are fine after build is done.
Run a test wheel build WITHOUT upload for release/x.y to ensure all the wheels build (see details)
Run BBP Simulation Stack & other relevant tests
Releasing
Update semantic version in CMakeLists.txt
Update changelog below and agree on it with everyone; then commit it to docs/changelog (copy structure as-is)
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-x.y, make sure the build passes and inspect the Changelog page.
Important: we print the following message from nrnivmodl on error. Make sure the URL is right one!
NOTE: If you are encountering MOD file compilation errors only with NEURON version 9.0 or later
refer to the C++ migration guide at https://nrn.readthedocs.io/en/9.0.0/guide/porting_mechanisms_to_cpp.html
Create new release+tag on GitHub via release workflow. Note that the GitHub release will be marked as pre-release and will contain the full-src-package and the Windows installer at the end of the release workflow.
Build release wheels but WITHOUT upload (see details)
Once wheels are published, activate the x.y.z tag on ReadTheDocs
Rename the Windows installer in the GitHub release to match the new version and the supported python versions (i.e. nrn-8.2.2.w64-mingw-py-37-38-39-310-311-setup.exe
)
Action items
Pre-release
Sanity checks
release/x.y
branch and make sure GitHub, Azure and CircleCI builds passrelease/x.y
& make it hidden. Check docs are fine after build is done.release/x.y
to ensure all the wheels build (see details)Releasing
CMakeLists.txt
docs/changelog
(copy structure as-is)docs/index.rst
accordingly with the new.pkg
and.exe
links forPKG installer
andWindows Installer
release-x.y
, make sure the build passes and inspect the Changelog page.Important: we print the following message from
nrnivmodl
on error. Make sure the URL is right one!release/x.y-aarch64
branch for this, see guide)x.y.z
wheels on Pypi; see wheel publishing instructionsx.y.z
tag on ReadTheDocsnrn-8.2.2.w64-mingw-py-37-38-39-310-311-setup.exe
)
Post-release
master
as follows:x.(y+1).dev
(x+1).0.dev
release/x.y
Default version
tox.y.z
master
Changelog
NEURON X.Y
[x.y.z]
Release Date : DD-MM-YYYY
What's New
Breaking Changes
Deprecations
Bug Fixes
Improvements / Other Changes
Upgrade Steps
For the complete list of features and bug fixes, see the list in GitHub Issue #[GH_no.]
ReadTheDocs sneak peek
Commits going into x.y.z
[given
a.b.c
is the last release:]Since [a.b.c], with:
git log --pretty=format:"%h : %s" a.b.c..release/x.y
we get:
The text was updated successfully, but these errors were encountered: