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
Next revisionBoth sides next revision
dev:release_checklist [2019/12/05 14:29] – adapt to new Git workflow (still WiP) tmuellerdev:release_checklist [2020/12/30 17:19] – oschuett
Line 23: Line 23:
  
   * a) Update the version in src/cp2k_info.F (comment/uncomment release/branch line, update release number and year),   * a) Update the version in src/cp2k_info.F (comment/uncomment release/branch line, update release number and year),
-  * b) Update the version in tools/doxify/Doxyfile.template +  * b) Create a file cp2k/REVISION with the revision number of the release branch add it:
-  * c) Provide Java version of [[http://sourceforge.net/projects/saxon|saxon]] for manual generation +
-  * d) Create a file cp2k/REVISION with the revision number of the release branch add it:+
  
 <code> <code>
 tools/build_utils/get_revision_number src >REVISION tools/build_utils/get_revision_number src >REVISION
 git add REVISION git add REVISION
-git commit -m "Store the revision number of the release branch" REVISION src/cp2k_info.F tools/doxify/Doxyfile.template+git commit -m "Store the revision number of the release branch" REVISION src/cp2k_info.F
 </code> </code>
 +
 +Example: https://github.com/cp2k/cp2k/commit/0bfbd41a7402152da7b86a103d5d95a4184367d9
  
 === 5. Compile the release branch version and run one or more regression tests === === 5. Compile the release branch version and run one or more regression tests ===
Line 55: Line 55:
 </code> </code>
  
-=== 7. Tag the release and push both tag and branch to GitHub ===+=== 7. Tag the release ===
  
 <code> <code>
 git tag -a -m "CP2K release X.Y.O" vX.Y.0 git tag -a -m "CP2K release X.Y.O" vX.Y.0
-git push --atomic upstream vX.Y.0 support/vX.Y 
 </code> </code>
  
 === 8. Increment the version number of the development version (skip this for sub-releases) === === 8. Increment the version number of the development version (skip this for sub-releases) ===
 +
 <code> <code>
 git checkout master git checkout master
-vim cp2k/src/cp2k_info.F cp2k/tools/doxify/Doxyfile.template +vim cp2k/src/cp2k_info.F 
-git commit - "Increment CP2K development version number" cp2k/src/cp2k_info.F cp2k/tools/doxify/Doxyfile.template+vim cp2k/tools/manual/index.html  
 +git commit - "Increment CP2K development version number" cp2k/src/cp2k_info.F
 </code> </code>
  
-=== 9. Update the CP2K web page ===+Example: https://github.com/cp2k/cp2k/commit/2285224d061d2bfa6d43c73cbb105229de504238 
 + 
 +=== 9. Push all branches to Github === 
 + 
 +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). 
 + 
 +<code> 
 +git push --atomic upstream support/vX.Y master vX.Y.0 
 +</code> 
 + 
 +After the workflow finishes, go to https://github.com/cp2k/cp2k/releases, add the release notes to the Draft release and publish the release. 
 + 
 +=== 10. Update the CP2K web page ===
  
   * Add [[:news|News]] entry   * Add [[:news|News]] entry
   * Update [[:version_history|Version History]]   * Update [[:version_history|Version History]]
  
-=== 10. Dissemination ===+=== 11. 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://groups.google.com/g/cp2k/c/QUTFLcaOrBc/m/fOrH4ReoAwAJ?pli=1|Example]])
   * the Twitter-sphere via the Twitter account   * the Twitter-sphere via the Twitter account
  
dev/release_checklist.txt · Last modified: 2024/05/05 19:43 by oschuett