CP2K Open Source Molecular Dynamics

User Tools

Site Tools

Trace: • release_checklist
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 [2024/08/06 12:42] – oschuettdev:release_checklist [2026/07/15 10:36] (current) – oschuett
Line 17: Line 17:
 </code> </code>
  
-Example: https://github.com/cp2k/cp2k/commit/056df93+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 25: Line 25:
 git push upstream_rw support/v20XX.Y v20XX.Y git push upstream_rw support/v20XX.Y v20XX.Y
 </code> </code>
 +
 +Github PR search: ''is:pr is:merged merged:>2025-07-22'' 
  
 === 4. Create tar ball and upload to new GitHub draft release === === 4. Create tar ball and upload to new GitHub draft release ===
Line 32: Line 34:
 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 50: Line 47:
 docker build -f ./Dockerfile.test_manual  --build-arg GIT_COMMIT_SHA=$(git rev-parse HEAD) -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:/var/www/cp2k.org/manual/cp2k-20XX_Y-branch+tar -czf release_manual.tgz ./manual/ 
 +scp release_manual.tgz sham: 
 +ssh sham tar -xzf release_manual.tgz 
 +ssh sham mv manual /var/www/cp2k.org/manual/cp2k-20XX_Y-branch 
 +ssh sham rm release_manual.tgz
 </code> </code>
  
 === 7. Update the main branch === === 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 .+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.
  
 === 8. 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 git tag on the [[:download#git_access|Download page]]   * Update git tag on the [[:download#git_access|Download page]]
  
-=== 9. Dissemination ===+ 
 +=== 9. Archive on Zenodo === 
 + 
 +Login in to https://zenodo.org to find out the new DOI that gets created automatically for every release. 
 + 
 +https://docs.github.com/de/repositories/archiving-a-github-repository/referencing-and-citing-content 
 + 
 +=== 10. Dissemination ===
  
 Inform the Inform the
Line 69: Line 76:
   * CP2K developers by email   * CP2K developers by email
   * CP2K users via the CP2K mailing list ([[https://groups.google.com/g/cp2k/c/ydyIJh2BPoE|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+  * <del>the Twitter-sphere via the Twitter account</del>
  
 about the new CP2K release. about the new CP2K release.
dev/release_checklist.1722948145.txt.gz · Last modified: by oschuett