Skip to content
David Ketcheson edited this page Jul 26, 2013 · 24 revisions

Release candidate procedure:

  1. Release notes: to be placed on the wiki and distributed to mailing lists (5 minutes)
  2. Edit changelog in clawpack/changes.md (Extended annotated review of major pull requests and commits) (5 minutes)
  3. Update/commit version number in clawpack/clawpack/setup.py, remove all others (15 minutes)
    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 and upload to clawpack.github.com (5 minutes)
    cd doc/doc
    vim conf.py
        version = 5.0
        release = 5.0.0rc-alpha
    save conf.py
    make html
    git add conf.py
    git commit
    bash rsync_clawpack.github.sh
  1. Upload documentation to GitHub (5 minutes)
    cd clawpack/clawpack.github.com
    git commit -a
    git push
  1. Tag commit to match version number in setup.py (30 seconds)
    cd clawpack
    git tag -a 5.0.0rc-alpha
    git push --tags
  1. Roll tarball and any other formats (30-60 minutes)
# brew install git-archive-all
git-archive-all clawpack-rc-alpha.tar
  1. Upload tarballs/binaries to GitHub (10 minutes)
  2. Update PyPI (30 minutes)
  3. Announce to claw-dev (5 minutes)
  4. Close any issues that arise (3 years)
  5. Repeat until issues stop arising (3 years)

Proper release procedure:

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

References: An Example PyPI Project

Clone this wiki locally