forked from clawpack/clawpack
-
Notifications
You must be signed in to change notification settings - Fork 1
Release procedure
Randall J. LeVeque edited this page Nov 10, 2015
·
24 revisions
Release candidate procedure:
- Make sure that clawpack/clawpack points to the latest master intended for release on each of the submodules and that tests pass.
- Release notes: to be placed on the wiki and distributed to mailing lists
- Edit changelog in clawpack/changes.md (Extended annotated review of major pull requests and commits)
- 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
- 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
- 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
- Upload documentation to GitHub
cd clawpack/clawpack.github.com
git commit -a
git push
- 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
- 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
- Upload tarballs/binaries to GitHub
https://github.com/clawpack/clawpack/releases
Drag and drop tar.gz file.
-
Update download URL under "full install" at http://clawpack.github.io/doc/installing.html.
-
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
-
Upload file: https://pypi.python.org/pypi?name=clawpack&version=5.0.0rc-alpha&:action=files
-
Announce to claw-dev
-
Close any issues that arise
-
Repeat until issues stop arising
Proper release procedure:
- Roll conda, hashdist, other installers
- Announce release notes to mailing lists
References: PyBayes release procedure