release every 3 months (at time
alladd your favorite Issues to the next-rel column
Scrum Masterprep dev meet (internal)
Update/trim next-release column in Kanban
Prepare agenda, include possible additions not covered by Kanban/Issues
Add milestone tags (nextver, nextver+1, etc.)
Add highlighted new features to RELEASE_NOTES.md
Release Managerdev meet (external/public)
Use Kanban as starter
Move issues around based on input
Add milestone tags, for this release or future releases
Update highlighted new features to RELEASE_NOTES.md
allreserve week for wrapping up PRs and review.
Have a look at Python release schedule, and time Arbor release optimally with new Python minor version. It is nice to generate wheels for the new minor as soon as minor is released.
set date for next release
These notes enumerate the steps required every time we release a new version of Arbor.
Make sure no errors were encountered in the pre-release phase, working wheels were produced, and were installable from Test.PyPI.org and that no problems were reported.
VERSION. Make sure does not end with
-dev. Push to the draft PR opened earlier for the rc.
When tests pass, merge the PR.
commit and either reuse the draft PR for the RC, or open a new one.
once merged, make and push tag.
git tag -a TAGNAME
git push upstream TAGNAME
Upload to pypi & verify
Get the wheels from test PyPI or the Github Action that produced the release artifacts. Make sure you have pip installed
twineand have your
~/.pypircfile setup with the right token (see docs).
twine upload -r arborpypi dist/* python -m venv env && source env/bin/activate pip install arbor python -c 'import arbor; print(arbor.__config__)'
Create Github Release: https://github.com/arbor-sim/arbor/releases
The Github action that produced the release artifacts should have prepared a draft Release.
Update body text with
(Probably: delete the Github draft release for the
If no Github Release was automatically drafted:
Go to GH tags and click “…” and “Create release”
Categorize/edit Github’s autogenerated release notes (alternatively go through merged PRs to come up with a changelog).
Manually build full tarball:
scripts/create_tarball ~/loc/of/arbor tagname outputfile
scripts/create_tarball /full/path/to/arbor v0.5.1 ~/arbor-v0.5.1-full.tar.gz
Start a new release on Zenodo, this allocated a DOI, but you don’t have to finish it right away. Add new Zenodo DOI badge/link to
Update Zenodo with authors and changelog created in previous step and submit.
Make a new PR setting
VERSIONto the next with a trailing
-dev. E.g. if you just released
3.15.16-dev. Make sure the number portion always consists of a triple. Shorter versions are uninstallable by Spack (
spack install firstname.lastname@example.org install v0.8.1, due to anything shorter than a triple being interpreted as a version range).
spack/package.py. The checksum of the targz is the sha256sum.
Include changes such as to
doc/index.rstin postrel PR. Copy Zenodo BibTex export to
scripts/check-all-tags.shto check the current tag.
Update spack package / Ebrains Lab / Opensourcebrain
Announce on our website
[AUTOMATED] Add tagged version of docs on ReadTheDocs
HBP internal admin
tldr: shoot your ticket here: email@example.com
Supported file formats
Release automation is a bit more advanced for Arbor GUI: the act of pushing a new tag, auto-drafts a release with the relevant artifacts. The post release steps mentioned above are largely the same. A list of the places where an update must be entered: