From 2bf5404776df258373c2df5f67482edf4daf9c82 Mon Sep 17 00:00:00 2001
From: Brent Huisman <brenthuisman@users.noreply.github.com>
Date: Thu, 27 Jan 2022 11:47:46 +0100
Subject: [PATCH] v0.6 post release (#1818)
* Update VERSION to `v0.6.1-dev`
* Updates to `doc/release.rst`
* Update Zenodo citation info for v0.6
* Update copyright info and maintainers in `spack/package.py` from upstream
* Fix error in build-badge docs
---
CITATION.bib | 18 +++++-----
VERSION | 2 +-
doc/contrib/release.rst | 73 +++++++++++++++++++++++++----------------
doc/index.rst | 10 ++++--
spack/package.py | 4 +--
5 files changed, 65 insertions(+), 42 deletions(-)
diff --git a/CITATION.bib b/CITATION.bib
index be62d506..60539fa3 100644
--- a/CITATION.bib
+++ b/CITATION.bib
@@ -8,7 +8,7 @@
doi={10.1109/EMPDP.2019.8671560},
ISSN={2377-5750}}
-@software{nora_abi_akar_2021_5031633,
+@software{nora_abi_akar_2022_5910151,
author = {Nora Abi Akar and
John Biddiscombe and
Benjamin Cumming and
@@ -25,12 +25,14 @@
Charl Linssen and
Harmen Stoppels and
Sebastian Schmitt and
- Felix Huber},
- title = {Arbor Library v0.5.2},
- month = jun,
- year = 2021,
+ Felix Huber and
+ Max Engelen and
+ Fabian Bösch},
+ title = {Arbor Library v0.6},
+ month = jan,
+ year = 2022,
publisher = {Zenodo},
- version = {v0.5.2},
- doi = {10.5281/zenodo.5031633},
- url = {https://doi.org/10.5281/zenodo.5031633}
+ version = {v0.6},
+ doi = {10.5281/zenodo.5910151},
+ url = {https://doi.org/10.5281/zenodo.5910151}
}
diff --git a/VERSION b/VERSION
index 5a2a5806..2feed2fe 100644
--- a/VERSION
+++ b/VERSION
@@ -1 +1 @@
-0.6
+0.6.1-dev
diff --git a/doc/contrib/release.rst b/doc/contrib/release.rst
index e787c69f..37a4adf8 100644
--- a/doc/contrib/release.rst
+++ b/doc/contrib/release.rst
@@ -58,64 +58,79 @@ Test the RC
python -m venv env && source env/bin/activate
pip install numpy
pip install -i https://test.pypi.org/simple/ arbor==0.6-rc
- python -c ’import arbor; print(arbor.__config__)’
+ python -c 'import arbor; print(arbor.__config__)'
Release
-------
0. Make sure ``ciwheel.yml`` passes tests, produced working wheels, and nobody reported problems testing the RC.
Make sure ``VERSION`` does not end with ``-rc`` or ``-dev``
-1. Tag and release: https://github.com/arbor-sim/arbor/releases
- - on cmdline: git tag -a TAGNAME
- - git push origin TAGNAME
- - Go to `GH tags`_ and click “…†and “Create releaseâ€
- - Go through merged PRs to come up with a changelog
-
-2. Create tarball with
+1. Create tarball with
``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``
+2. Tag and release: https://github.com/arbor-sim/arbor/releases
+
+ - on cmdline: git tag -a TAGNAME
+ - git push upstream TAGNAME
+ - Go to `GH tags`_ and click “…†and “Create releaseâ€
+ - Go through merged PRs to come up with a changelog
+ Or categorize/edit Github's autogenerated release notes.
+ - add tarball to release, created in previous step.
+
3. [`AUTOMATED`_] push to git@gitlab.ebrains.eu:arbor-sim/arbor.git
-4. Download output of wheel action and extract (verify the wheels and
+
+4. Download output of wheel action associated to this release commit and extract (verify the wheels and
source targz is in /dist)
-5. Verify wheel
- - create venv: python -m venv env && source env/bin/activate
- - pip install arbor-0.5.1-cp39-cp39-manylinux2014_x86_64.whl
- - python -c ’import arbor; print(arbor.__config__)’
+ - Of course, the above action must have passed the tests successfully.
-6. Upload to pypi
+5. Upload to TEST pypi & verify
- - twine upload -r arborpypi dist\*
+.. code-block:: bash
-7. Verify
+ twine upload -r arborpypi dist/*
+ python -m venv env && source env/bin/activate
+ pip install numpy
+ pip install -i https://test.pypi.org/simple/ arbor==0.6
+ python -c 'import arbor; print(arbor.__config__)'
- - create venv: python -m venv env && source env/bin/activate
- - pip install arbor==0.5.1 –verbose
- - python -c ’import arbor; print(arbor.__config__)’
+6. Upload to pypi & verify
-Post release
-------------
+.. code-block:: bash
+
+ twine upload -r arborpypi dist/*
+
+ python -m venv env && source env/bin/activate
+ pip install arbor
+ python -c 'import arbor; print(arbor.__config__)'
-1. Update spack package
+7. Update spack package
- first, update ``spack/package.py``. The checksum of the targz is the sha256sum.
- - Then, use the file to `make PR here <https://github.com/spack/spack/blob/develop/var/spack/repos/builtin/packages/>`_
+ - Then, use the file to `make PR here <https://github.com/spack/spack/blob/develop/var/spack/repos/builtin/packages/arbor/package.py>`_
-2. In the same PR with the update to `spack/package.py`, might as well bump `VERSION` file.
-3. Announce on our website
-4. Add release for citation on Zenodo, add new ID to docs
-5. Add tagged version of docs on ReadTheDocs (should happen automatically)
-6. HBP internal admin
+8. In the same PR with the update to `spack/package.py`, bump `VERSION` file.
+
+ - e.g. to 0.6.1-dev
+
+Post Release
+------------
+
+1. Announce on our website
+2. Add release for citation on Zenodo, add new ID to docs
+3. Add tagged version of docs on ReadTheDocs (should happen automatically)
+4. HBP internal admin
- [Plus](https://plus.humanbrainproject.eu/components/2691/)
- [TC Wiki](https://wiki.ebrains.eu/bin/view/Collabs/technical-coordination/EBRAINS%20components/Arbor/)
- [KG](https://kg.ebrains.eu/search/instances/Software/80d205a9-ffb9-4afe-90b8-2f12819950ec) - [Update howto](https://github.com/bweyers/HBPVisCatalogue/wiki/How-to-start-software-meta-data-curation%3F#update-curated-software).
- Supported file formats (ie [ContentTypes](https://humanbrainproject.github.io/openMINDS/v3/core/v4/data/contentType.html)), [details](https://github.com/HumanBrainProject/openMINDS_core/tree/v3/instances/data/contentTypes)
- Send an update to the folk in charge of HBP Twitter if we want to shout about it
-7. FZJ admin
+
+5. FZJ admin
- https://juser.fz-juelich.de/submit
diff --git a/doc/index.rst b/doc/index.rst
index c03fecff..bde48890 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -3,8 +3,8 @@ Arbor
|testbadge| |zlatest|
-.. |testbadge| image:: https://github.com/arbor-sim/arbor/actions/workflows/basic.yml/badge.svg
- :target: https://github.com/arbor-sim/arbor/actions/workflows/basic.yml
+.. |testbadge| image:: https://github.com/arbor-sim/arbor/actions/workflows/test-everything.yml/badge.svg
+ :target: https://github.com/arbor-sim/arbor/actions/workflows/test-everything.yml
Welcome to the documentation for Arbor, the multi-compartment neural network simulation library.
@@ -38,6 +38,9 @@ The Arbor software can be cited by version via Zenodo or via Arbors introductory
Latest version
|zlatest|
+Version 0.6
+ |z06|
+
Version 0.5.2
|z052|
@@ -64,6 +67,9 @@ Cite (Bibtex format)
.. |zlatest| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.1459678.svg
:target: https://doi.org/10.5281/zenodo.1459678
+.. |z06| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.5910151.svg
+ :target: https://doi.org/10.5281/zenodo.5910151
+
.. |z052| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.5031633.svg
:target: https://doi.org/10.5281/zenodo.5031633
diff --git a/spack/package.py b/spack/package.py
index bce24cce..c9d1e1e1 100644
--- a/spack/package.py
+++ b/spack/package.py
@@ -1,4 +1,4 @@
-# Copyright 2013-2021 Lawrence Livermore National Security, LLC and other
+# Copyright 2013-2022 Lawrence Livermore National Security, LLC and other
# Spack Project Developers. See the top-level COPYRIGHT file for details.
#
# SPDX-License-Identifier: (Apache-2.0 OR MIT)
@@ -13,7 +13,7 @@ class Arbor(CMakePackage, CudaPackage):
homepage = 'https://arbor-sim.org'
git = 'https://github.com/arbor-sim/arbor.git'
url = 'https://github.com/arbor-sim/arbor/releases/download/v0.6/arbor-v0.6-full.tar.gz'
- maintainers = ['bcumming', 'brenthuisman', 'haampie', 'halfflat']
+ maintainers = ['bcumming', 'brenthuisman', 'haampie', 'schmitts']
version('master', branch='master', submodules=True)
version('0.6', sha256='4cd333b18effc8833428ddc0b99e7dc976804771bc85da90034c272c7019e1e8', url='https://github.com/arbor-sim/arbor/releases/download/v0.6/arbor-v0.6-full.tar.gz')
--
GitLab