diff options
Diffstat (limited to 'RELEASING.txt')
| -rw-r--r-- | RELEASING.txt | 26 |
1 files changed, 20 insertions, 6 deletions
diff --git a/RELEASING.txt b/RELEASING.txt index 75a4fcea2..866fff305 100644 --- a/RELEASING.txt +++ b/RELEASING.txt @@ -1,7 +1,18 @@ Releasing Pyramid ================= -- Do any necessary branch merges (e.g. master to branch, branch to master). +- For clarity, we define releases as follows. + + - Alpha, beta, dev and similar statuses do not qualify whether a release is + major or minor. The term "pre-release" means alpha, beta, or dev. + + - A *major* release is where the first number either before or after the + first dot increases. Examples: 1.6 to 1.7a1, or 1.8 to 2.0. + + - A *minor* or *bug fix* release is where the number after the second dot + increases. Example: 1.6 to 1.6.1. + +- Do any necessary branch merges (e.g., master to branch, branch to master). - On release branch: @@ -15,8 +26,8 @@ Releasing Pyramid - Run tests on Windows if feasible. -- Make sure all scaffold tests pass (Py 2.6, 2.7, 3.2, 3.3, 3.4, 3.5, pypy, and - pypy3 on UNIX; this doesn't work on Windows): +- Make sure all scaffold tests pass (Py 2.7, 3.3, 3.4, 3.5, pypy, and pypy3 on + UNIX; this doesn't work on Windows): $ ./scaffoldtests.sh @@ -26,7 +37,7 @@ Releasing Pyramid - Copy relevant changes (delta bug fixes) from CHANGES.txt to docs/whatsnew-X.X (if it's a major release). Minor releases should include a link under "Bug Fix Releases" to the minor feature - changes in CHANGES.txt . + changes in CHANGES.txt. - 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". @@ -34,12 +45,15 @@ Releasing Pyramid - Update whatsnew-X.X.rst in docs to point at change log entries for individual releases if applicable. +- For major version releases, in contributing.md, update branch descriptions. + - For major version releases, in docs/conf.py, update values under html_theme_options for in_progress and outdated across master, releasing branch, and previously released branch. Also in the previously released branch only, uncomment the sections to enable pylons_sphinx_latesturl. -- Change setup.py version to the new version number. +- Change setup.py version to the new version number on both master and the new + branch. - Change CHANGES.txt heading to reflect the new version number. @@ -50,7 +64,7 @@ Releasing Pyramid - Create a release tag. -- Make sure your Python has ``setuptools-git``, ``twine`` and ``wheel`` +- Make sure your Python has ``setuptools-git``, ``twine``, and ``wheel`` installed and release to PyPI:: $ python setup.py sdist bdist_wheel |