Releases¶
Release cycle¶
release every 3 months (at time
T
)T-11
weeks:all
add your favorite Issues to the next-rel columnT-10
weeks:Scrum Master
prep 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
T-8
weeks:Release Manager
dev 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
T-1
:all
reserve week for wrapping up PRs and review.T±0
:Release Manager
release!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.
T+1
weeks:Scrum Master
retrospectiveset date for next release
Procedure¶
These notes enumerate the steps required every time we release a new version of Arbor.
Pre-release¶
Release¶
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.
Change
VERSION
. Make sure does not end with-rc
or-dev
. Push to the draft PR opened earlier for the rc.When tests pass, merge the PR.
Tag
commit and either reuse the draft PR for the RC, or open a new one.
once merged, make and push tag.
on cmdline:
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
twine
and have your~/.pypirc
file 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
CHANGELOG.md
(Probably: delete the Github draft release for the
-rc
)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
eg
scripts/create_tarball /full/path/to/arbor v0.5.1 ~/arbor-v0.5.1-full.tar.gz
Post Release¶
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
CITATION.bib
anddocs/index.rst
.Update Zenodo with authors and changelog created in previous step and submit.
Make a new PR setting
VERSION
to the next with a trailing-dev
. E.g. if you just released3.14.15
, changeVERSION
to3.15.16-dev
. Make sure the number portion always consists of a triple. Shorter versions are uninstallable by Spack (spack install arbor@0.8
will install v0.8.1, due to anything shorter than a triple being interpreted as a version range).Update
spack/package.py
. The checksum of the targz is the sha256sum.Include changes such as to
CITATIONS
,doc/index.rst
in postrel PR. Copy Zenodo BibTex export toCITATIONS
.
Update
scripts/check-all-tags.sh
to check the current tag.Update spack package / Ebrains Lab / Opensourcebrain
Spack upstream: PR here
Ebrains Lab: MR here
OSB: update requirementsfile if needed.
Make sure that Notebooks work on the version that their image is built with.
Announce on our website
Announce on HBP newsletter newsletter@humanbrainproject.eu, communications@ebrains.eu, HBP Twitter/socials evan.hancock@ebrains.eu
[AUTOMATED] Add tagged version of docs on ReadTheDocs
HBP internal admin
TC Wiki: https://wiki.ebrains.eu/bin/view/Collabs/technical-coordination/EBRAINS%20components/Arbor/
KG: https://search.kg.ebrains.eu/instances/5cf4e24b-b0eb-4d05-96e5-a7751134a061
Update howto: https://wiki.ebrains.eu/bin/view/Collabs/swc-guide#HHowtoupdateexistingSoftwareinstances
tldr: shoot your ticket here: curation-support@humanbrainproject.eu
Supported file formats
FZJ admin
GUI¶
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: