CP2K Open Source Molecular Dynamics

User Tools

Site Tools

Trace:
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
dev:release_checklist [2022/12/31 12:46] – oschuettdev:release_checklist [2025/01/01 14:41] (current) – oschuett
Line 9: Line 9:
 </code> </code>
  
-Edit the ''cp2k_version'' string in [[src>src/cp2k_info.F]] (⚠️ remove the  ''Development Version'').+Edit the ''cp2k_version'' string in [[src>src/cp2k_info.F]] and [[src>CMakeLists.txt]] (⚠️ 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 src/cp2k_info.F +git add REVISION src/cp2k_info.F CMakeLists.txt 
-git commit -m "Cut release version 20XX.Y" REVISION src/cp2k_info.F+git commit -m "Cut release version 20XX.Y"
 </code> </code>
  
-Example: https://github.com/cp2k/cp2k/commit/71f6a37+Example: https://github.com/cp2k/cp2k/commit/6608d10
  
 === 3. Tag the release and push to GitHub === === 3. Tag the release and push to GitHub ===
Line 23: Line 23:
 <code> <code>
 git tag -m "Cut release version 20XX.Y" -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 32: Line 32:
 git-archive-all ./cp2k-20XX.Y.tar.bz2 git-archive-all ./cp2k-20XX.Y.tar.bz2
 </code> </code>
 +
 +ProTip:
 +https://github.com/cp2k/cp2k/pulls?q=is%3Apr+is%3Amerged+closed%3A%3E2024-08-05
  
 === 5. Create and upload binaries and Docker images === === 5. Create and upload binaries and Docker images ===
 +
 +<code>
 +cd cp2k/tools/docker
 +./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" === === 6. Create a new manual on "cp2k.org" ===
Line 39: Line 51:
 <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) --build-arg ADD_EDIT_LINKS=no -t manual_img ../../+docker build -f ./Dockerfile.test_manual  --build-arg GIT_COMMIT_SHA=$(git rev-parse HEAD) -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 ===
  
-Example: https://github.com/cp2k/cp2k/commit/8ed2d75+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]] and [[src>CMakeLists.txt]]. Example: https://github.com/cp2k/cp2k/commit/faa0fcc.
  
-=== 7. 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]]
  
-=== 8. 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/3iY5NhOBLhk/m/f8-fgNiwBAAJ|Example]] - ⚠️ check greeting!)+  * 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.1672490807.txt.gz · Last modified: 2022/12/31 12:46 by oschuett