From 169dba5c7aa02db2e48cecff8b8126b767fdf327 Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Wed, 23 Dec 2015 03:19:58 -0800 Subject: - Add Python compatibility to history, hacking, releasing - Use 1.X for version number --- RELEASING.txt | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) (limited to 'RELEASING.txt') diff --git a/RELEASING.txt b/RELEASING.txt index 87ff62c53..fa4ebab5b 100644 --- a/RELEASING.txt +++ b/RELEASING.txt @@ -15,7 +15,7 @@ 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, pypy, and +- 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): $ ./scaffoldtests.sh @@ -69,22 +69,22 @@ Releasing Pyramid Announcement template ---------------------- -Pyramid 1.1.X has been released. +Pyramid 1.X.X has been released. Here are the changes: <> -A "What's New In Pyramid 1.1" document exists at -http://docs.pylonsproject.org/projects/pyramid/1.1/whatsnew-1.1.html . +A "What's New In Pyramid 1.X" document exists at +http://docs.pylonsproject.org/projects/pyramid/1.X/whatsnew-1.X.html . -You will be able to see the 1.1 release documentation (across all +You will be able to see the 1.X 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/ . +at http://docs.pylonsproject.org/projects/pyramid/1.X/ . You can install it via PyPI: - easy_install Pyramid==1.1a4 + easy_install Pyramid==1.X Enjoy, and please report any issues you find to the issue tracker at https://github.com/Pylons/pyramid/issues -- cgit v1.2.3 From f8309dd390a2045e3ccf8a1d029b6ff8bb0c0a23 Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Thu, 7 Jan 2016 00:13:27 -0800 Subject: add trypyramid.com to update for releases --- RELEASING.txt | 3 +++ 1 file changed, 3 insertions(+) (limited to 'RELEASING.txt') diff --git a/RELEASING.txt b/RELEASING.txt index fa4ebab5b..61420ce8b 100644 --- a/RELEASING.txt +++ b/RELEASING.txt @@ -55,6 +55,9 @@ Releasing Pyramid - Edit Pylons/pylonshq/templates/home/inside.rst for major updates only. +- Edit Pylons/trypyramid.com/src/templates/resources.html for major updates + only. + - Edit Pylons/pylonsrtd/pylonsrtd/docs/pyramid.rst for all updates. - Edit `http://wiki.python.org/moin/WebFrameworks -- cgit v1.2.3 From a9f92bebb31eeeb43fc79eef132567c9abdb3719 Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Fri, 29 Jan 2016 22:39:19 -0800 Subject: add update docs/conf.py for RELEASING.txt --- RELEASING.txt | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) (limited to 'RELEASING.txt') diff --git a/RELEASING.txt b/RELEASING.txt index 61420ce8b..bc8f2c721 100644 --- a/RELEASING.txt +++ b/RELEASING.txt @@ -28,12 +28,16 @@ Releasing Pyramid include a link under "Bug Fix Releases" to the minor feature changes in CHANGES.txt . -- update README.rst to use correct versions of badges and URLs according to +- 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". - Update whatsnew-X.X.rst in docs to point at change log entries for individual releases if applicable. +- 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. + - Change setup.py version to the new version number. - Change CHANGES.txt heading to reflect the new version number. -- cgit v1.2.3 From 48738dc116f9916356ac1d41029c3682b978a4ed Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Sat, 30 Jan 2016 18:04:49 -0800 Subject: add instructions for enabling pylons_sphinx_latesturl on previously released branch when making a new major release --- RELEASING.txt | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'RELEASING.txt') diff --git a/RELEASING.txt b/RELEASING.txt index bc8f2c721..142005ed7 100644 --- a/RELEASING.txt +++ b/RELEASING.txt @@ -36,7 +36,8 @@ Releasing Pyramid - 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. + 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. -- cgit v1.2.3 From daa0e4deaca9d087e0feef46083e42974d6e1115 Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Wed, 3 Feb 2016 02:15:09 -0800 Subject: each step is for every release, unless explicitly stated as "major release only" --- RELEASING.txt | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'RELEASING.txt') diff --git a/RELEASING.txt b/RELEASING.txt index 142005ed7..75a4fcea2 100644 --- a/RELEASING.txt +++ b/RELEASING.txt @@ -56,14 +56,14 @@ Releasing Pyramid $ python setup.py sdist bdist_wheel $ twine upload dist/pyramid-X.X-* -- Edit Pylons/pylonshq/templates/home/home.mako for minor and major updates. +- Edit Pylons/pylonshq/templates/home/home.mako. -- Edit Pylons/pylonshq/templates/home/inside.rst for major updates only. +- Edit Pylons/pylonshq/templates/home/inside.rst for major releases only. -- Edit Pylons/trypyramid.com/src/templates/resources.html for major updates +- Edit Pylons/trypyramid.com/src/templates/resources.html for major releases only. -- Edit Pylons/pylonsrtd/pylonsrtd/docs/pyramid.rst for all updates. +- Edit Pylons/pylonsrtd/pylonsrtd/docs/pyramid.rst for major releases only. - Edit `http://wiki.python.org/moin/WebFrameworks `_. -- cgit v1.2.3 From 19af3f4f5c3ad69ea6b71d63e18aa86fe8f69aae Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Mon, 29 Feb 2016 15:04:23 -0800 Subject: add step to update contributing.md --- RELEASING.txt | 2 ++ 1 file changed, 2 insertions(+) (limited to 'RELEASING.txt') diff --git a/RELEASING.txt b/RELEASING.txt index 75a4fcea2..b69971710 100644 --- a/RELEASING.txt +++ b/RELEASING.txt @@ -34,6 +34,8 @@ 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 -- cgit v1.2.3 From 30884b15582b8612716eb43a76f0d5e84f54772c Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Fri, 15 Apr 2016 02:20:44 -0700 Subject: remove 2.6 and 3.2, minor cleanup --- RELEASING.txt | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'RELEASING.txt') diff --git a/RELEASING.txt b/RELEASING.txt index b69971710..614d3257b 100644 --- a/RELEASING.txt +++ b/RELEASING.txt @@ -15,8 +15,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 +26,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". @@ -52,7 +52,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 -- cgit v1.2.3 From 7c9eab4730efac736064ec35a312d3a7936674d2 Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Sun, 17 Apr 2016 01:31:55 -0700 Subject: update RELEASING.txt with version terms, extra step update conf.py with clearer comments and prep for rolldown for 1.6 --- RELEASING.txt | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) (limited to 'RELEASING.txt') diff --git a/RELEASING.txt b/RELEASING.txt index 614d3257b..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: @@ -41,7 +52,8 @@ Releasing Pyramid 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. -- cgit v1.2.3 From a575d1f9d77195d53f55fa8b409bd7c21f3f64de Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Sun, 17 Apr 2016 15:38:26 -0700 Subject: update RELEASING.txt to better account for master and previous branches - add term "final" release - explicitify the implicit - --- RELEASING.txt | 69 +++++++++++++++++++++++++++++++++++++++++++++++++---------- 1 file changed, 58 insertions(+), 11 deletions(-) (limited to 'RELEASING.txt') diff --git a/RELEASING.txt b/RELEASING.txt index 866fff305..8b3d908e6 100644 --- a/RELEASING.txt +++ b/RELEASING.txt @@ -6,12 +6,19 @@ Releasing Pyramid - 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 release is final when it is no longer pre-release. + - 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. +Prepare new release branch +-------------------------- + +- Create a new release branch, incrementing the version number. + - Do any necessary branch merges (e.g., master to branch, branch to master). - On release branch: @@ -34,6 +41,8 @@ Releasing Pyramid - Ensure all features of the release are documented (audit CHANGES.txt or communicate with contributors). +- Change CHANGES.txt heading to reflect the new version number. + - 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 @@ -52,10 +61,7 @@ Releasing Pyramid 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 on both master and the new - branch. - -- Change CHANGES.txt heading to reflect the new version number. +- Change setup.py version to the release version number. - Make sure PyPI long description renders (requires ``collective.dist`` installed into your Python):: @@ -70,6 +76,37 @@ Releasing Pyramid $ python setup.py sdist bdist_wheel $ twine upload dist/pyramid-X.X-* +- Configure RTD to publish the new release version of the docs. + +Prepare master for further development (major releases only) +------------------------------------------------------------ + +- Checkout master. + +- In CHANGES.txt, preserve headings but clear out content. + +- From the release branch, forward port the changes in CHANGES.txt to + HISTORY.txt. + +- In contributing.md, forward port branch descriptions from release branch. + +- In docs/conf.py, add a commented line under + pylons_sphinx_latesturl_pagename_overrides for the release. + +- Change setup.py version to the next version number. + +Update previous version (final releases only) +--------------------------------------------- + +- In docs/conf.py, update values under html_theme_options for in_progress and + outdated. Uncomment the sections to enable pylons_sphinx_latesturl. + +- Configure RTD to point the "latest" alias to the new release version of the + docs. + +Marketing and communications +---------------------------- + - Edit Pylons/pylonshq/templates/home/home.mako. - Edit Pylons/pylonshq/templates/home/inside.rst for major releases only. @@ -82,15 +119,24 @@ Releasing Pyramid - Edit `http://wiki.python.org/moin/WebFrameworks `_. -- Publish new version of docs. +- Announce to Twitter. -- Announce to maillist. +``` +Pyramid 1.x released. -- Announce to Twitter. +PyPI +https://pypi.python.org/pypi/pyramid/1.x + +What's New +http://docs.pylonsproject.org/projects/pyramid/1.X/whatsnew-1.X.html -Announcement template ----------------------- +Issues +https://github.com/Pylons/pyramid/issues +``` + +- Announce to maillist. +``` Pyramid 1.X.X has been released. Here are the changes: @@ -106,11 +152,12 @@ at http://docs.pylonsproject.org/projects/pyramid/1.X/ . You can install it via PyPI: - easy_install Pyramid==1.X + pip install Pyramid==1.X Enjoy, and please report any issues you find to the issue tracker at https://github.com/Pylons/pyramid/issues Thanks! -- C +- Pyramid core developers +``` -- cgit v1.2.3 From b5237a573acb1dedebc236e852f4437c66fd26be Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Sun, 17 Apr 2016 15:54:06 -0700 Subject: update RELEASING.txt with "unreleased" heading --- RELEASING.txt | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'RELEASING.txt') diff --git a/RELEASING.txt b/RELEASING.txt index 8b3d908e6..e50adb52b 100644 --- a/RELEASING.txt +++ b/RELEASING.txt @@ -83,7 +83,8 @@ Prepare master for further development (major releases only) - Checkout master. -- In CHANGES.txt, preserve headings but clear out content. +- In CHANGES.txt, preserve headings but clear out content. Add heading + "unreleased" for the version number. - From the release branch, forward port the changes in CHANGES.txt to HISTORY.txt. -- cgit v1.2.3 From 13522a677e2700c84a10709fd758f379110780f8 Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Tue, 19 Apr 2016 23:42:18 -0700 Subject: Fix what's new links in templates with "-branch" in RELEASING.txt --- RELEASING.txt | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'RELEASING.txt') diff --git a/RELEASING.txt b/RELEASING.txt index e50adb52b..78fd98f52 100644 --- a/RELEASING.txt +++ b/RELEASING.txt @@ -129,7 +129,7 @@ PyPI https://pypi.python.org/pypi/pyramid/1.x What's New -http://docs.pylonsproject.org/projects/pyramid/1.X/whatsnew-1.X.html +http://docs.pylonsproject.org/projects/pyramid/1.X-branch/whatsnew-1.X.html Issues https://github.com/Pylons/pyramid/issues @@ -145,11 +145,11 @@ Here are the changes: <> A "What's New In Pyramid 1.X" document exists at -http://docs.pylonsproject.org/projects/pyramid/1.X/whatsnew-1.X.html . +http://docs.pylonsproject.org/projects/pyramid/1.X-branch/whatsnew-1.X.html . You will be able to see the 1.X 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.X/ . +at http://docs.pylonsproject.org/projects/pyramid/1.X-branch/ . You can install it via PyPI: -- cgit v1.2.3 From 478c6ef8c05bea4541844e40c9428d573266e9dc Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Mon, 2 May 2016 04:35:45 -0700 Subject: fix what's new link (cherry picked from commit 023b6ba) --- RELEASING.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'RELEASING.txt') diff --git a/RELEASING.txt b/RELEASING.txt index 78fd98f52..a09b6d24a 100644 --- a/RELEASING.txt +++ b/RELEASING.txt @@ -129,7 +129,7 @@ PyPI https://pypi.python.org/pypi/pyramid/1.x What's New -http://docs.pylonsproject.org/projects/pyramid/1.X-branch/whatsnew-1.X.html +http://docs.pylonsproject.org/projects/pyramid/en/1.X-branch/whatsnew-1.X.html Issues https://github.com/Pylons/pyramid/issues -- cgit v1.2.3 From 1d7501afdda49cf5e7561e542988581c360f4ed2 Mon Sep 17 00:00:00 2001 From: Michael Merickel Date: Tue, 10 May 2016 00:42:08 -0500 Subject: drop pypy3 from scaffold tests --- RELEASING.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'RELEASING.txt') diff --git a/RELEASING.txt b/RELEASING.txt index a09b6d24a..4b4f40f99 100644 --- a/RELEASING.txt +++ b/RELEASING.txt @@ -33,8 +33,8 @@ Prepare new release branch - Run tests on Windows if feasible. -- 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): +- Make sure all scaffold tests pass (Py 2.7, 3.3, 3.4, 3.5, and pypy on UNIX; + this doesn't work on Windows): $ ./scaffoldtests.sh -- cgit v1.2.3 From 9b4eedc84c335b690f04fc155ccd38a615b9594b Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Tue, 10 May 2016 00:04:32 -0700 Subject: update twitter announcement --- RELEASING.txt | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'RELEASING.txt') diff --git a/RELEASING.txt b/RELEASING.txt index 4b4f40f99..d8572fa94 100644 --- a/RELEASING.txt +++ b/RELEASING.txt @@ -128,8 +128,12 @@ Pyramid 1.x released. PyPI https://pypi.python.org/pypi/pyramid/1.x +=== One time only for new version, first pre-release === What's New http://docs.pylonsproject.org/projects/pyramid/en/1.X-branch/whatsnew-1.X.html +=== For all subsequent pre-releases === +Changes +http://docs.pylonsproject.org/projects/pyramid/en/1.X-branch/changes.html#version-yyyy-mm-dd Issues https://github.com/Pylons/pyramid/issues -- cgit v1.2.3