Skip to content
Snippets Groups Projects
Unverified Commit ba781cb5 authored by Brent Huisman's avatar Brent Huisman Committed by GitHub
Browse files

Minor updates to docs, spack file. (#1823)

* Some badges corrected (build) and added (Gitter)
* Minor Spack backports
* Small updates to `release.rst`
parent 94f95bc9
No related branches found
No related tags found
No related merge requests found
[![hpc ci](https://gitlab.com/cscs-ci/arbor-sim/arbor/badges/master/pipeline.svg)](https://gitlab.com/cscs-ci/arbor-sim/arbor/-/commits/master) [![hpc ci](https://gitlab.com/cscs-ci/arbor-sim/arbor/badges/master/pipeline.svg)](https://gitlab.com/cscs-ci/arbor-sim/arbor/-/commits/master)
[![basic ci](https://github.com/arbor-sim/arbor/actions/workflows/basic.yml/badge.svg)](https://github.com/arbor-sim/arbor/actions/workflows/basic.yml) [![basic ci](https://github.com/arbor-sim/arbor/actions/workflows/basic.yml/badge.svg)](https://github.com/arbor-sim/arbor/actions/workflows/test-everything.yml)
[![gitpod](https://img.shields.io/badge/Gitpod-Ready--to--Code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/arbor-sim/arbor) [![gitpod](https://img.shields.io/badge/Gitpod-Ready--to--Code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/arbor-sim/arbor)
[![docs](https://readthedocs.org/projects/arbor/badge/?version=latest)](https://docs.arbor-sim.org/en/latest/) [![docs](https://readthedocs.org/projects/arbor/badge/?version=latest)](https://docs.arbor-sim.org/en/latest/)
[![Gitter](https://badges.gitter.im/arbor-sim.svg)](https://gitter.im/arbor-sim/community) [![Gitter](https://badges.gitter.im/arbor-sim/community.svg)](https://gitter.im/arbor-sim/community)
# Arbor Library # Arbor Library
......
...@@ -11,13 +11,18 @@ Release cycle ...@@ -11,13 +11,18 @@ Release cycle
* Update/trim next-release column in Kanban * Update/trim next-release column in Kanban
* Prepare agenda, include possible additions not covered by Kanban/Issues * Prepare agenda, include possible additions not covered by Kanban/Issues
* Add milestone tags (nextver, nextver+1, etc.) * Add milestone tags (nextver, nextver+1, etc.)
* Add highlighted new features to RELEASE_NOTES.md
3. ``T-8`` weeks: ``Release Manager`` dev meet (external/public) 3. ``T-8`` weeks: ``Release Manager`` dev meet (external/public)
* Use Kanban as starter * Use Kanban as starter
* Move issues around based on input * Move issues around based on input
* Add milestone tags, for this release or future releases * Add milestone tags, for this release or future releases
4. ``T±0``: ``Release Manager`` release! * Update highlighted new features to RELEASE_NOTES.md
5. ``T+1`` weeks: ``Scrum Master`` retrospective 4. ``T-1``: ``all`` reserve week for wrapping up PRs and review.
5. ``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.
6. ``T+1`` weeks: ``Scrum Master`` retrospective
* set date for next release * set date for next release
...@@ -33,7 +38,7 @@ Pre-release ...@@ -33,7 +38,7 @@ Pre-release
Update tags/versions and test Update tags/versions and test
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
0. Check README.md, ATTRIBUTIONS.md, CONTRIBUTING.md. 0. Check README.md, ATTRIBUTIONS.md, CONTRIBUTING.md, RELEASE_NOTES.md
1. Create new temp-branch ending in ``-rc``. E.g. ``v0.6-rc`` 1. Create new temp-branch ending in ``-rc``. E.g. ``v0.6-rc``
2. Bump the ``VERSION`` file: 2. Bump the ``VERSION`` file:
https://github.com/arbor-sim/arbor/blob/master/VERSION https://github.com/arbor-sim/arbor/blob/master/VERSION
...@@ -107,27 +112,38 @@ Release ...@@ -107,27 +112,38 @@ Release
pip install arbor pip install arbor
python -c 'import arbor; print(arbor.__config__)' python -c 'import arbor; print(arbor.__config__)'
7. Update spack package 7. Update spack package / Ebrains Lab
- first, update ``spack/package.py``. The checksum of the targz is the sha256sum. - 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/arbor/package.py>`_ - Then, use the file to `make PR here <https://github.com/spack/spack/blob/develop/var/spack/repos/builtin/packages/arbor/package.py>`_
- Make an MR `here <https://gitlab.ebrains.eu/technical-coordination/project-internal/devops/platform/ebrains-spack-builds/>`_
8. In the same PR with the update to `spack/package.py`, bump `VERSION` file. 8. In the same PR with the update to `spack/package.py`, bump `VERSION` file.
- e.g. to 0.6.1-dev - e.g. to 0.6.1-dev
9. In the same PR with the update to `spack/package.py`, add new Zenodo badge/link.
- Start a new release on Zenodo, this allocated a DOI, but you don't have to finish it right away.
OTOH, you can already make and upload the tarball in step 1.
Post Release Post Release
------------ ------------
0. Update and submit Zenodo release if necessary.
1. Announce on our website 1. Announce on our website
2. Add release for citation on Zenodo, add new ID to docs 2. Announce on HBP newsletter newsletter@humanbrainproject.eu, HBP Twitter/socials evan.hancock@ebrains.eu
3. Add tagged version of docs on ReadTheDocs (should happen automatically) 3. [AUTOMATED] Add tagged version of docs on ReadTheDocs
4. HBP internal admin 4. HBP internal admin
- [Plus](https://plus.humanbrainproject.eu/components/2691/) - Plus: https://plus.humanbrainproject.eu/components/2691/
- [TC Wiki](https://wiki.ebrains.eu/bin/view/Collabs/technical-coordination/EBRAINS%20components/Arbor/) - 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). - KG: https://search.kg.ebrains.eu/instances/5cf4e24b-b0eb-4d05-96e5-a7751134a061
- 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) - Update howto: https://github.com/bweyers/HBPVisCatalogue/wiki/How-to-start-software-meta-data-curation%3F#update-curated-software
- Previous update as template: https://github.com/bweyers/HBPVisCatalogue/issues/480
- Supported file formats
- 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 - Send an update to the folk in charge of HBP Twitter if we want to shout about it
5. FZJ admin 5. FZJ admin
......
Arbor Arbor
===== =====
|testbadge| |zlatest| |testbadge| |zlatest| |gitter|
.. |testbadge| image:: https://github.com/arbor-sim/arbor/actions/workflows/test-everything.yml/badge.svg .. |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 :target: https://github.com/arbor-sim/arbor/actions/workflows/test-everything.yml
.. |gitter| image:: https://badges.gitter.im/arbor-sim/community.svg
:target: https://gitter.im/arbor-sim/community
Welcome to the documentation for Arbor, the multi-compartment neural network simulation library. Welcome to the documentation for Arbor, the multi-compartment neural network simulation library.
You can find out how to :ref:`get Arbor<in_install>`; get started quickly with our :ref:`tutorials<tutorial>`; or continue reading to learn more about Arbor. You can find out how to :ref:`get Arbor<in_install>`; get started quickly with our :ref:`tutorials<tutorial>`; or continue reading to learn more about Arbor.
......
...@@ -37,7 +37,7 @@ class Arbor(CMakePackage, CudaPackage): ...@@ -37,7 +37,7 @@ class Arbor(CMakePackage, CudaPackage):
depends_on('cmake@3.12:', type='build') depends_on('cmake@3.12:', type='build')
# misc dependencies # misc dependencies
depends_on('fmt@7.1:', when='@0.5.3:') # required by the modcc compiler depends_on('fmt@7.1:', when='@0.5.3:') # required by the modcc compiler
depends_on('nlohmann-json') depends_on('nlohmann-json')
depends_on('cuda@10:', when='+cuda') depends_on('cuda@10:', when='+cuda')
depends_on('libxml2', when='+neuroml') depends_on('libxml2', when='+neuroml')
...@@ -50,7 +50,9 @@ class Arbor(CMakePackage, CudaPackage): ...@@ -50,7 +50,9 @@ class Arbor(CMakePackage, CudaPackage):
extends('python', when='+python') extends('python', when='+python')
depends_on('python@3.6:', when="+python", type=('build', 'run')) depends_on('python@3.6:', when="+python", type=('build', 'run'))
depends_on('py-numpy', when='+python', type=('build', 'run')) depends_on('py-numpy', when='+python', type=('build', 'run'))
depends_on('py-pybind11@2.8.1:', when='+python', type=('build', 'run')) with when('+python'):
depends_on('py-pybind11@2.6:', type=('build', 'run'))
depends_on('py-pybind11@2.8.1:', when='@0.5.3:', type=('build', 'run'))
# sphinx based documentation # sphinx based documentation
depends_on('python@3.6:', when="+doc", type='build') depends_on('python@3.6:', when="+doc", type='build')
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment