diff --git a/release_procedure.rst b/release_procedure.rst index c2b895a1..e2fc3a82 100644 --- a/release_procedure.rst +++ b/release_procedure.rst @@ -4,33 +4,39 @@ Release procedure This document describes how to prepare a new BIDScoin release from within the DCCN + from a Linux VM -1. Inspect the git history and update the CHANGELOG (including the links) -2. Delete the ``.bidscoin`` config folder -3. Update the version string everywhere (i.e. search without word matching), COPYRIGHT and cli help texts -4. Add a git version tag -5. Backport to PyQt5 in a v4.#.#+qt5 branch -6. Manually run the bidscoin, bidsmapper, bidscoiner, bids-validator and other integration tests -7. Run tox@DCCN:: +1. Delete the ``.bidscoin`` config folder +2. Manually run the tox, bidscoin, bidsmapper, bidscoiner, bids-validator and other integration tests +3. Inspect the git history and update the CHANGELOG (including the links) +4. Update the version string everywhere (i.e. search without word matching), COPYRIGHT and cli help texts +5. Add a git version tag +6. Backport to PyQt5 in a v4.#.#+qt5 branch +7. Build & test the containers in a Linux VM:: + + VERSION="4.3.3" + rm -rf ~/.bidscoin/$VERSION + cd ~/PycharmProjects/bidscoin + sudo apptainer build bidscoin.sif apptainer.def + xhost + + apptainer exec --cleanenv --env DISPLAY=:0 bidscoin.sif bidscoin -t + apptainer exec --cleanenv --env DISPLAY=:0 bidscoin.sif pngappend + apptainer cache clean + +8. Run tox@DCCN:: VERSION="4.3.3" cd ~/python/bidscoin + git pull git checkout v${VERSION}+qt5 + git pull module load bidscoin/dev source activate tox + rm -rf ~/.bidscoin/$VERSION tox conda deactivate source activate /opt/bidscoin ~/python/bidscoin/bidscoin/bcoin.py -t -8. Push the qt5-branch -9. Build & test the containers in a Linux VM:: - - cd ~/PycharmProjects/bidscoin - sudo apptainer build bidscoin.sif apptainer.def - xhost + - apptainer exec --cleanenv --env DISPLAY=:0 bidscoin.sif bidscoin -t - apptainer exec --cleanenv --env DISPLAY=:0 bidscoin.sif pngappend - apptainer cache clean +9. Push the qt5-branch DCCN deployment ---------------