Merge pull request geodynamics#2902 from tjhei/update_release_tasks

update release tasks
freddrichards · Apr 30, 2019 · 7ca9833 · 7ca9833
2 parents 3a9bb0e + 12f936a
commit 7ca9833
Showing 1 changed file with 23 additions and 8 deletions.
diff --git a/doc/release-tasklist b/doc/release-tasklist
@@ -15,7 +15,7 @@
     - format is X.Y.Z for a release, X.Y.Z-pre for the dev version or X.Y.Z-rcW for release candidates
     - backwards incompatible changes require incrementing X, adding features incrementing Y
   . setup:
-      export OLDVER=1.5.0;export VER=2.0.0;export VERSHORT=2.0;export NEXTVER=2.1.0-pre
+      export OLDVER=2.0.0;export VER=2.1.0;export VERSHORT=2.1;export NEXTVER=2.2.0-pre
       export DEALSRCDIR=/ssd/deal-git/
   . fix doxygen errors:
       find include -name "*h" -print | xargs -n 1 $DEALSRCDIR/contrib/utilities/checkdoxygen.py
@@ -25,8 +25,10 @@
     . make manual.pdf
     . grep undefined manual/manual.log    # try to remove some
     . make aspect.tag
+    . and check for warnings
   . fix formatting, copyright years:
       find . -name "*.h" -print | while read file;do $DEALSRCDIR/contrib/utilities/wrapcomments.py $file >temp;mv temp $file;done
+      . note: we started ignoring the rewrapping of comments, but we should still fix wrong indentation or other problems
       ./doc/indent
       ./doc/update_copyright.sh
       git commit -a -m "doxygen formatting, comment wrapping"
@@ -37,12 +39,13 @@
       cd doc;./bump_version.sh $NEXTVER; cd ..
       git commit -m "release task: update version and changes.h"
       # create a PR
-  . create a branch, bump version: # TODO: this should be 2.0.0-pre not 2.0.0
+  . create a branch, bump version (note, make sure the PR above is included)
       git checkout post-release-$VER && \
       git checkout -b aspect-$VERSHORT && \
       cd doc && ./bump_version.sh $VER && cd .. && \
       git commit -m "release task: update version info"
   . compile aspect, make sure you have a symlink in the main directory for the next step
+    - make sure the WorldBuilder is found! (git submodule init)
   . update doc/manual/parameters.tex and documentation:
       cd doc && ./update_parameters.sh && make manual.pdf && cp manual.pdf manual-$VER.pdf && cd .. && \
       git add doc/manual/parameters.tex && \
@@ -60,7 +63,16 @@
   . create a tar file:
       cd doc && make manual.pdf && cp manual.pdf aspect-manual-$TAG.pdf && cd ..
       export PREFIX=aspect-$TAG && rm -rf $PREFIX.tar.gz && \
-      git archive --format=tar.gz --prefix=$PREFIX/ HEAD >$PREFIX.tar.gz && rm -rf $PREFIX
+      git archive --format=tar.gz --prefix=$PREFIX/ HEAD >temp.tar.gz && \
+      rm -fr $PREFIX/ && \
+      tar xf temp.tar.gz && \
+      cd contrib/WorldBuilder/ && \
+      git archive --format=tar.gz --prefix=$PREFIX/contrib/WorldBuilder/ HEAD >temp.tar.gz && \
+      cd ../.. && \
+      tar xf contrib/WorldBuilder/temp.tar.gz && \
+      tar czf $PREFIX.tar.gz $PREFIX/ && \
+      rm -rf contrib/WorldBuilder/temp.tar.gz
+
   . final testing by extracting tarball, compiling, and running:
       tar xf $PREFIX.tar.gz
       cd $PREFIX
@@ -78,10 +90,9 @@
   . sign:
       gpg --detach-sign --armor aspect-$TAG.tar.gz
       sha1sum aspect-$TAG.tar.gz
-      gpg --detach-sign --armor manual-$TAG.pdf
-      sha1sum aspect-$TAG.tar.gz manual-$TAG.pdf >sha1sum-$TAG.txt
+      gpg --detach-sign --armor aspect-manual-$TAG.pdf
+      sha1sum aspect-$TAG.tar.gz aspect-manual-$TAG.pdf >sha1sum-$TAG.txt
   . create a release on github, upload tar.gz and manual-$VER.pdf
-  . readme / release notes: add zenodo DOI button
   . link it on download.html, update version info etc.
   . create zenodo release for source code:
     - https://zenodo.org/deposit?page=1&size=20
@@ -91,9 +102,13 @@
     - cig community!
     - update zenodo badge in README.md to newest version (see badge button on the right of zenodo page)
     - add zenodo badge also to the release on github (on top, see 2.0.1 for an example)
+    - readme / release notes: add zenodo DOI button
   . create figshare DOI for manual
-  . update doc/manual/aspect.bib with src and manual doi
-  . update aspect.geodynamics.org/cite.html
+  . update doc/manual/manual.bib with src and manual doi
+  . update aspect.geodynamics.org/cite.html and citing.html in www repo:
+    - change link in cite.html
+    - add new version in citing.html, search for "<option"
+    - run aspect/doc/ python3 make_cite_html.py add to www
   . update http://geodynamics.org/cig/software/aspect/:
        update current release number
        create entry for the new release