dev:release_checklist
Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
| dev:release_checklist [2014/12/22 10:32] – Update release protocol krack | dev:release_checklist [2023/07/22 12:02] – oschuett | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== | + | ====== |
| - | === 1. Agreement about a new release branch X.Y among the CP2K developers === | + | === 1. Check that the dashboard is green and there are no other blocking issues |
| - | === 2. Check if the following requirements for the release | + | |
| - | * a) Clean status for all dashboard regression testers | + | |
| - | * b) Successful build and clean regtest of the gfortran sdbg, sopt, popt, pdbg, ssmp, and psmp versions | + | |
| - | * c) Check the SMP executables with H2O-32 benchmark input, e.g. using the script | + | |
| - | <code bash> | + | === 2. Cut the release version |
| - | #!/bin/sh | + | |
| - | cwd=$PWD | + | |
| - | cd cp2k/ | + | |
| - | # | + | |
| - | ../ | + | |
| - | export OMP_NUM_THREADS=1 | + | |
| - | mpiexec -np 8 ../ | + | |
| - | # | + | |
| - | ../ | + | |
| - | export OMP_NUM_THREADS=1 | + | |
| - | mpiexec -np 8 ../ | + | |
| - | # | + | |
| - | ../ | + | |
| - | export OMP_NUM_THREADS=2 | + | |
| - | mpiexec -np 4 ../ | + | |
| - | # | + | |
| - | ../ | + | |
| - | export OMP_NUM_THREADS=4 | + | |
| - | mpiexec -np 2 ../ | + | |
| - | # | + | |
| - | ../ | + | |
| - | export OMP_NUM_THREADS=8 | + | |
| - | mpiexec -np 1 ../ | + | |
| - | # | + | |
| - | ../ | + | |
| - | export OMP_NUM_THREADS=8 | + | |
| - | ../ | + | |
| - | # | + | |
| - | cd ${cwd} | + | |
| - | # | + | |
| - | for f in H2O-32-*.out; | + | |
| - | </ | + | |
| - | The final energies of all MD runs should agree by 10< | + | |
| - | === 3. Create a new branch directory on the SVN server using === | ||
| < | < | ||
| - | svn mkdir svn+ssh://mkrack@svn.code.sf.net/ | + | git checkout -b support/v20XX.Y |
| </ | </ | ||
| - | Description text: " | ||
| - | === 4. Copy the current CP2K version from the trunk using === | + | Edit the '' |
| - | <code> | + | |
| - | svn copy -m " | + | |
| - | svn+ssh:// | + | |
| - | svn+ssh:// | + | |
| - | </ | + | |
| - | === 5. Check the release version out using === | + | |
| - | < | + | |
| - | svn co svn+ssh:// | + | |
| - | </ | + | |
| - | === 6. Apply release specific changes === | + | |
| - | * a) Change | + | |
| - | * b) Provide Java version of [[http:// | + | |
| - | * c) Create a file cp2k/ | + | |
| - | < | + | |
| - | cd cp2k-X_Y-branch/ | + | |
| - | tools/ | + | |
| - | svn add REVISION | + | |
| - | svn ci -m "Store the revision number of the release branch" | + | |
| - | cd .. | + | |
| - | </ | + | |
| - | === 7. Compile the release branch version and run one or more regression tests === | ||
| - | The reference outputs can be retrieved from the branched CP2K trunk version: | ||
| < | < | ||
| - | cp -a ../trunk/LAST-Linux-x86-64-gfortran-regtest-pdbg/ | + | tools/build_utils/get_revision_number src > |
| - | cp2k/tools/ | + | git add REVISION src/cp2k_info.F |
| - | cp -a ../trunk/ | + | git commit |
| - | cp2k/ | + | |
| </ | </ | ||
| - | === 8. Create a new manual on " | + | Example: https://github.com/cp2k/cp2k/commit/71f6a37 |
| - | * a) Login to " | + | |
| - | * b) Create a new folder '' | + | === 3. Tag the release and push to GitHub === |
| - | * c) Add a new link in the index.html file and logout | + | |
| - | * c) Create and upload the new manual: | + | |
| - | < | + | |
| - | cd cp2k/tools/manual | + | |
| - | ./update_manual Linux-x86-64-gfortran-regtest pdbg mkrack@5.35.252.240:/ | + | |
| - | </ | + | |
| - | === 9. Export the release branch (checkout without .svn folders) using === | ||
| < | < | ||
| - | svn export http://svn.code.sf.net/p/ | + | git tag -m "Cut release version 20XX.Y" -a v20XX.Y |
| + | git push upstream_rw support/v20XX.Y v20XX.Y | ||
| </ | </ | ||
| - | === 10. Create | + | === 4. Create tar ball and upload to new GitHub draft release |
| < | < | ||
| - | tar -cjf cp2k-X.Y.Z.tar.bz2 | + | pip3 install git-archive-all |
| + | git-archive-all ./cp2k-20XX.Y.tar.bz2 | ||
| </ | </ | ||
| - | === 11. Check the exported branch release (just compile it or even run a regtest) | + | === 5. Create and upload binaries and Docker images |
| - | === 12. Create | + | === 6. Create |
| - | === 13. Upload the tar file to sourceforge to make it appear in the list under " | ||
| < | < | ||
| - | scp cp2k-X.Y.Z/exe/Linux-x86-64-gfortran-static/ | + | cd cp2k/ |
| - | scp cp2k-X.Y.Z/exe/Linux-x86-64-gfortran-static/ | + | docker build -f ./Dockerfile.test_manual |
| - | scp cp2k-X.Y.Z.tar.bz2 mkrack@frs.sourceforge.net:/home/frs/project/cp2k/cp2k-X.Y.Z.tar.bz2 | + | docker run -v " |
| + | scp -r manual sham:/var/www/cp2k.org/manual/cp2k-20XX_Y-branch | ||
| </ | </ | ||
| - | === 14. Increment the version number of the development version | + | Add a new link in the [[src>tools/ |
| - | <code> | + | |
| - | cp2k/src/cp2k_info.F | + | Example: https://github.com/cp2k/cp2k/commit/8ed2d75 |
| - | cp2k/tools/doxify/Doxyfile.template | + | |
| - | cd cp2k | + | === 7. Update the CP2K web page === |
| - | svn ci -m " | + | |
| - | </ | + | |
| - | === 15. Update the CP2K web page === | ||
| * Add [[: | * Add [[: | ||
| * Update [[: | * Update [[: | ||
| - | * Add a link to the new input reference manual under [[:docs|Documentation & Help]] | + | * Update git tag on the [[:download# |
| + | |||
| + | === 8. Dissemination === | ||
| - | === 16. Dissemination === | ||
| Inform the | Inform the | ||
| + | |||
| * CP2K developers by email | * CP2K developers by email | ||
| - | * CP2K users via the CP2K mailing list | + | * CP2K users via the CP2K mailing list ([[https:// |
| - | about the new CP2K release. | + | |
| - | For a new sub-release | + | about the new CP2K release. |
dev/release_checklist.txt · Last modified: 2024/08/06 14:45 by oschuett