RELEASE-CHECKLIST.txt 1.68 KB
Newer Older
Philip Carns's avatar
Philip Carns committed
1 2 3 4
Notes on how to release a new version of Darshan
2013-05
-----------------------

5
- check Darshan GitLab to see if there are any pending tickets for this
Philip Carns's avatar
Philip Carns committed
6
  release/milestone if applicable
7
  (https://xgitlab.cels.anl.gov/darshan/darshan/milestones)
Philip Carns's avatar
Philip Carns committed
8 9 10
- check for any problems in jenkins nightly builds
- make sure that documentation in darshan-util/doc/ and darshan-runtime/doc/
  are up to date
11
- update the Changelog if needed (browse git log since last release)
Philip Carns's avatar
Philip Carns committed
12 13 14 15 16 17 18
  - commit
- update version number in configure.in (see AC_INIT)
  - in both darshan-util/ and darshan-runtime/
  - re-run ./prepare in both darshan-util and darshan-runtime
  - commit
- generate example output files on x86_64, ppc32, and ppc64, commit in
  darshan-test/example-output/ directory
19 20 21 22
- use "git status" to make sure that all changes have been committed and
  pushed to origin/master
- make a tag for the release according to instructions at
  http://git-scm.com/book/en/Git-Basics-Tagging
23 24 25
  - example (annotated tag, pushed to repo):
    git tag -a darshan-2.3.1-pre2 -m 'Darshan 2.3.1-pre2'
    git push origin darshan-2.3.1-pre2
Philip Carns's avatar
Philip Carns committed
26
- TESTING
27 28 29
  - manually trigger jenkins test
  - run regression tests on BG platform (see
    darshan-test/regression/README.BG.txt)
Philip Carns's avatar
Philip Carns committed
30 31 32
- export the tag and tar gzip it
  - easiest method is to do a fresh checkout and remove the .git
    subdirectory
Philip Carns's avatar
Philip Carns committed
33 34 35 36 37 38 39
  - upload .tar.gz file to /mcs/ftp/pub/darshan/releases
- generate web documentation from asciidoc by running make in
  darshan-util/doc/ and darshan-runtime/doc/ directories
  - upload .html files to /mcs/web/research/projects/darshan/docs
- update download page on darshan web site: www.mcs.anl.gov/darshan/download
- announce on web page (new post) and mailing list