User Tools

Site Tools


dev:release_checklist

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
Last revisionBoth sides next revision
dev:release_checklist [2022/07/09 11:39] oschuettdev:release_checklist [2024/01/01 23:40] oschuett
Line 9: Line 9:
 </code> </code>
  
-Edit the ''cp2k_version'' string in [[src>src/cp2k_info.F]].+Edit the ''cp2k_version'' string in [[src>src/cp2k_info.F]] (⚠️ remove the  ''Development Version'').
  
 <code> <code>
 tools/build_utils/get_revision_number src >REVISION tools/build_utils/get_revision_number src >REVISION
-git add REVISION +git add REVISION src/cp2k_info.F 
-git add  src/cp2k_info.F +git commit -m "Cut release version 20XX.Y"
-git commit -m "Cut release version 20XX.Y" REVISION src/cp2k_info.F+
 </code> </code>
  
-Example: https://github.com/cp2k/cp2k/commit/71f6a37b341cf3ba5a6d2009587e99a31707c00b+Example: https://github.com/cp2k/cp2k/commit/056df93
  
 === 3. Tag the release and push to GitHub === === 3. Tag the release and push to GitHub ===
  
 <code> <code>
-git tag -a v20XX.Y +git tag -m "Cut release version 20XX.Y" -a v20XX.Y 
-git push upstream support/v20XX.Y v20XX.Y+git push upstream_rw support/v20XX.Y v20XX.Y
 </code> </code>
  
Line 34: Line 33:
 </code> </code>
  
-=== 5. Create a new manual on "cp2k.org" ===+=== 5. Create and upload binaries and Docker images ===
  
 <code> <code>
 cd cp2k/tools/docker cd cp2k/tools/docker
-docker build -f ./Dockerfile.test_manual  --build-arg GIT_COMMIT_SHA=$(git rev-parse HEAD) -t manual_img ../../+./build_dockerhub_images.sh 
 +docker tag cp2k/cp2k:devZZZZZZZZ  cp2k/cp2k:20XX.Y 
 +docker tag cp2k/cp2k:devZZZZZZZZ  cp2k/cp2k:latest 
 +docker push cp2k/cp2k:20XX.Y 
 +docker push cp2k/cp2k:latest 
 +</code> 
 + 
 +=== 6. Create a new manual on "cp2k.org" === 
 + 
 +<code> 
 +cd cp2k/tools/docker 
 +docker build -f ./Dockerfile.test_manual  --build-arg GIT_COMMIT_SHA=$(git rev-parse HEAD) --build-arg ADD_EDIT_LINKS=no -t manual_img ../../
 docker run -v "$(pwd)":/mnt manual_img cp -rv  /workspace/artifacts/manual /mnt/ docker run -v "$(pwd)":/mnt manual_img cp -rv  /workspace/artifacts/manual /mnt/
-scp -r manual sham.cp2k.org:/var/www/cp2k.org/manual/cp2k-20XX_Y-branch+scp -r manual sham:/var/www/cp2k.org/manual/cp2k-20XX_Y-branch
 </code> </code>
  
-Add a new link in the [[src>tools/manual/index.html]] file and commit that change.+=== 7. Update the main branch === 
 + 
 +Change back to the main branch to add a new link to [[src>docs/versions.md]] and [[src>docs/index.md]]and update the development version in [[src>src/cp2k_info.F]]. Example: https://github.com/cp2k/cp2k/commit/0904149 .
  
-=== 6. Update the CP2K web page ===+=== 8. Update the CP2K web page ===
  
   * Add [[:news|News]] entry   * Add [[:news|News]] entry
   * Update [[:version_history|Version History]]   * Update [[:version_history|Version History]]
-  * Update [[:download#git_access|Git command line]]+  * Update git tag on the [[:download#git_access|Download page]]
  
-=== 7. Dissemination ===+=== 9. Dissemination ===
  
 Inform the Inform the
  
   * CP2K developers by email   * CP2K developers by email
-  * CP2K users via the CP2K mailing list ([[https://groups.google.com/g/cp2k/c/giii6D3ttxo|Example]])+  * CP2K users via the CP2K mailing list ([[https://groups.google.com/g/cp2k/c/ydyIJh2BPoE|Example]] - ⚠️ check greeting!)
   * the Twitter-sphere via the Twitter account   * the Twitter-sphere via the Twitter account
  
 about the new CP2K release. about the new CP2K release.
dev/release_checklist.txt · Last modified: 2024/05/05 19:43 by oschuett