dev:release_checklist
Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
| dev:release_checklist [2020/12/30 17:19] – oschuett | dev:release_checklist [2024/01/01 23:40] (current) – 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 generated executables with the H2O-32 benchmark input, e.g. using the script | + | |
| - | < | + | === 2. Cut the release version |
| - | cd cp2k/ | + | |
| - | ./ | + | |
| - | </ | + | |
| - | + | ||
| - | The final energies of all MD runs should agree by 10< | + | |
| - | + | ||
| - | === 3. Create a new branch from the current master using === | + | |
| < | < | ||
| - | git checkout -b support/vX.Y | + | git checkout -b support/v20XX.Y |
| </ | </ | ||
| - | === 4. Apply release specific changes === | + | Edit the '' |
| - | + | ||
| - | * a) Update | + | |
| - | * b) Create a file cp2k/ | + | |
| < | < | ||
| tools/ | tools/ | ||
| - | git add REVISION | + | git add REVISION |
| - | git commit -m "Store the revision number of the release | + | git commit -m "Cut release |
| </ | </ | ||
| - | Example: https:// | + | Example: https:// |
| - | === 5. Compile | + | === 3. Tag the release and push to GitHub |
| - | The reference outputs can be retrieved from the branched CP2K trunk version: | ||
| < | < | ||
| - | cp -a ../ | + | git tag -m "Cut release version 20XX.Y" |
| - | cp2k/ | + | git push upstream_rw support/v20XX.Y v20XX.Y |
| - | cp -a ../ | + | |
| - | cp2k/tools/ | + | |
| </ | </ | ||
| - | === 6. Create | + | === 4. Create |
| - | + | ||
| - | * a) Login to " | + | |
| - | * b) Create a new folder ''/ | + | |
| - | * c) Add a new link in the cp2k/ | + | |
| - | * d) Create and upload the new manual: | + | |
| < | < | ||
| - | cd cp2k/ | + | pip3 install git-archive-all |
| - | ./ | + | git-archive-all ./cp2k-20XX.Y.tar.bz2 |
| </ | </ | ||
| - | === 7. Tag the release | + | === 5. Create and upload binaries and Docker images |
| < | < | ||
| - | git tag -a -m "CP2K release X.Y.O" vX.Y.0 | + | cd cp2k/ |
| + | ./ | ||
| + | docker tag cp2k/ | ||
| + | docker tag cp2k/ | ||
| + | docker push cp2k/ | ||
| + | docker push cp2k/ | ||
| </ | </ | ||
| - | === 8. Increment the version number of the development version (skip this for sub-releases) | + | === 6. Create a new manual on " |
| < | < | ||
| - | git checkout master | + | cd cp2k/tools/docker |
| - | vim cp2k/src/cp2k_info.F | + | docker build -f ./Dockerfile.test_manual |
| - | vim cp2k/tools/manual/ | + | docker run -v "$(pwd)":/mnt manual_img cp -rv |
| - | git commit | + | scp -r manual sham:/ |
| </ | </ | ||
| - | Example: https:// | + | === 7. Update the main branch === |
| - | === 9. Push all branches | + | Change back to the main branch to add a new link to [[src> |
| - | This needs direct push access to master and will start the Github Actions Workflow to create a Draft release for the tag and upload the complete source tarball there (including all submodules). | + | === 8. Update the CP2K web page === |
| - | + | ||
| - | < | + | |
| - | git push --atomic upstream support/ | + | |
| - | </ | + | |
| - | + | ||
| - | After the workflow finishes, go to https:// | + | |
| - | + | ||
| - | === 10. Update the CP2K web page === | + | |
| * Add [[: | * Add [[: | ||
| * Update [[: | * Update [[: | ||
| + | * Update git tag on the [[: | ||
| - | === 11. Dissemination === | + | === 9. Dissemination === |
| Inform the | Inform the | ||
| * CP2K developers by email | * CP2K developers by email | ||
| - | * CP2K users via the CP2K mailing list ([[https:// | + | * CP2K users via the CP2K mailing list ([[https:// |
| * the Twitter-sphere via the Twitter account | * the Twitter-sphere via the Twitter account | ||
| about the new CP2K release. | about the new CP2K release. | ||
| - | |||
| - | For a new sub-release X.Y repeat 3-7, correspondingly. | ||
dev/release_checklist.1609348792.txt.gz · Last modified: 2020/12/30 17:19 by oschuett