Skip to content
Randall J. LeVeque edited this page Nov 10, 2015 · 24 revisions

Release candidate procedure:

  1. Make sure that clawpack/clawpack points to the latest master intended for release on each of the submodules and that tests pass.
  2. Release notes: to be placed on the wiki and distributed to mailing lists
  3. Edit changelog in clawpack/changes.md (Extended annotated review of major pull requests and commits)
  4. Update/commit version number in clawpack/setup.py, remove all others
    vim setup.py
        MAJOR               = 5
        MINOR               = 0
        MICRO               = 0
        TYPE                = 'rc-alpha'
    git add setup.py
    git commit
  1. Update version number in doc/doc/conf.py
    cd doc/doc
    vim conf.py
        version = 5.0
        release = 5.0.0rc-alpha
    save conf.py
    git add conf.py
    git commit
  1. Rebuild docs and galleries and upload to clawpack.github.com
    cd clawpack/doc/doc/pyclaw/gallery
    python make_plots.py
    python gallery.py
    cd ../..
    make html
    bash rsync_clawpack.github.sh
  1. Upload documentation to GitHub
    cd clawpack/clawpack.github.com
    git commit -a
    git push
  1. Tag commit to match version number in setup.py
    cd clawpack
    git tag -a 5.0.0rc-alpha -m "Version 5.0.0rc-alpha"
    git push --tags

Do the same in all subrepositories

  1. Roll tarball and any other formats
# brew install git-archive-all
git-archive-all --prefix clawpack-5.0.0rc-alpha/ clawpack-5.0.0rc-alpha.tar
gzip clawpack-rc-alpha.tar
  1. Upload tarballs/binaries to GitHub
https://github.com/clawpack/clawpack/releases
Drag and drop tar.gz file.
  1. Update download URL under "full install" at http://clawpack.github.io/doc/installing.html.

  2. Update PyPI

git branch -b 5.0.x
git add setup.py
git push clawpack 5.0.x:5.0.x
python setup.py register
  1. Upload file: https://pypi.python.org/pypi?name=clawpack&version=5.0.0rc-alpha&:action=files

  2. Announce to claw-dev

  3. Close any issues that arise

  4. Repeat until issues stop arising

Proper release procedure:

  1. Roll conda, hashdist, other installers
  2. Announce release notes to mailing lists

References: PyBayes release procedure

Clone this wiki locally