RELEASING.txt

Releasing Pyramid
=================

- Do any necessary branch merges (e.g. master to branch, branch to master).

- On release branch:

  $ git pull

- Do platform test via tox:

  $ tox -r

  Make sure statement coverage is at 100%::

- Run Windows tests for Python 2.6, 2.7, 3.2, and 3.3 if feasible.

- Make sure all scaffold tests pass (Py 2.6, 2.7, 3.2, 3.3 and pypy on UNIX;
  this doesn't work on Windows):

  $ tox py3-scaffolds
  $ tox py2-scaffolds
  $ tox pypy-scaffolds
  $ tox pypy3-scaffolds

- Ensure all features of the release are documented (audit CHANGES.txt or
  communicate with contributors).

- Copy relevant changes (delta bug fixes) from CHANGES.txt to
  docs/whatsnew-X.X (if it's a major release).

- update README.rst to use correct versions of badges and URLs according to
  each branch and context, i.e., RTD "latest" == GitHub/Travis "1.x-branch".

- Make sure docs render OK::

  $ cd docs
  $ make clean html

  There should be no meaningful errors or warnings.

- Change setup.py version to the new version number.

- Change CHANGES.txt heading to reflect the new version number.

- Make sure PyPI long description renders (requires ``collective.dist``
  installed into your Python)::

  $ python setup.py check -r

- Create a release tag.

- Make sure your system Python has ``setuptools-git`` installed and release to
  PyPI::

  $ python setup.py sdist register upload

- Edit `http://wiki.python.org/moin/WebFrameworks
  <http://wiki.python.org/moin/WebFrameworks>`_.

- Publish new version of docs.

- Announce to maillist.

- Announce to Twitter.

Announcement template
----------------------

Pyramid 1.1.X has been released.

Here are the changes:

<<changes>>

A "What's New In Pyramid 1.1" document exists at
http://docs.pylonsproject.org/projects/pyramid/1.1/whatsnew-1.1.html .

You will be able to see the 1.1 release documentation (across all
alphas and betas, as well as when it eventually gets to final release)
at http://docs.pylonsproject.org/projects/pyramid/1.1/ .

You can install it via PyPI:

  easy_install Pyramid==1.1a4

Enjoy, and please report any issues you find to the issue tracker at
https://github.com/Pylons/pyramid/issues

Thanks!

- C