summaryrefslogtreecommitdiff
path: root/docs/internals/release-process.txt
diff options
context:
space:
mode:
authorAymeric Augustin <aymeric.augustin@m4x.org>2013-02-24 11:38:34 +0100
committerAymeric Augustin <aymeric.augustin@m4x.org>2013-02-25 20:23:26 +0100
commit5d883589a8f6950e98538c9509a201d61573460d (patch)
treecf0950e56b9d4079fa9301d22c2efb706b9843a8 /docs/internals/release-process.txt
parentf1255a3c0904a55ef267fa5f8687a1ce78f6894a (diff)
Updated the release process docs to reflect the current practices.
Fixed #17919.
Diffstat (limited to 'docs/internals/release-process.txt')
-rw-r--r--docs/internals/release-process.txt156
1 files changed, 82 insertions, 74 deletions
diff --git a/docs/internals/release-process.txt b/docs/internals/release-process.txt
index 8affddb5e0..29ce3914b4 100644
--- a/docs/internals/release-process.txt
+++ b/docs/internals/release-process.txt
@@ -13,12 +13,12 @@ Since version 1.0, Django's release numbering works as follows:
* ``A`` is the *major version* number, which is only incremented for major
changes to Django, and these changes are not necessarily
- backwards-compatible. That is, code you wrote for Django 1.2 may break
+ backwards-compatible. That is, code you wrote for Django 1.6 may break
when we release Django 2.0.
* ``B`` is the *minor version* number, which is incremented for large yet
- backwards compatible changes. Code written for Django 1.2 will continue
- to work under Django 1.3. Exceptions to this rule will be listed in the
+ backwards compatible changes. Code written for Django 1.6 will continue
+ to work under Django 1.7. Exceptions to this rule will be listed in the
release notes.
* ``C`` is the *micro version* number, which is incremented for bug and
@@ -27,67 +27,62 @@ Since version 1.0, Django's release numbering works as follows:
can't be fixed without breaking backwards-compatibility. If this happens,
the release notes will provide detailed upgrade instructions.
-* In some cases, we'll make alpha, beta, or release candidate releases.
- These are of the form ``A.B alpha/beta/rc N``, which means the ``Nth``
- alpha/beta/release candidate of version ``A.B``.
+* Before a new minor release, we'll make alpha, beta, and release candidate
+ releases. These are of the form ``A.B alpha/beta/rc N``, which means the
+ ``Nth`` alpha/beta/release candidate of version ``A.B``.
-In git, each Django release will have a tag indicating its version
-number, signed with the Django release key. Additionally, each release
-series (X.Y) has its own branch, and bugfix/security releases will be
+In git, each Django release will have a tag indicating its version number,
+signed with the Django release key. Additionally, each release series has its
+own branch, called ``stable/A.B.x``, and bugfix/security releases will be
issued from those branches.
-For more information about how the Django project issues new releases
-for security purposes, please see :doc:`our security policies
-<security>`.
+For more information about how the Django project issues new releases for
+security purposes, please see :doc:`our security policies <security>`.
Major releases
--------------
Major releases (1.0, 2.0, etc.) will happen very infrequently (think "years",
-not "months"), and will probably represent major, sweeping changes to Django.
+not "months"), and may represent major, sweeping changes to Django.
Minor releases
--------------
-Minor release (1.1, 1.2, etc.) will happen roughly every nine months -- see
-`release process`_, below for details.
+Minor release (1.5, 1.6, etc.) will happen roughly every nine months -- see
+`release process`_, below for details. These releases will contain new
+features, improvements to existing features, and such.
.. _internal-release-deprecation-policy:
-These releases will contain new features, improvements to existing features, and
-such. A minor release may deprecate certain features from previous releases. If a
-feature in version ``A.B`` is deprecated, it will continue to work in version
-``A.B+1``. In version ``A.B+2``, use of the feature will raise a
-``DeprecationWarning`` but will continue to work. Version ``A.B+3`` will
-remove the feature entirely.
+A minor release may deprecate certain features from previous releases. If a
+feature is deprecated in version ``A.B``, it will continue to work in versions
+``A.B`` and ``A.B+1`` but raise warnings. It will be removed in version
+``A.B+2``.
-So, for example, if we decided to remove a function that existed in Django 1.0:
+So, for example, if we decided to start the deprecation of a function in
+Django 1.5:
-* Django 1.1 will contain a backwards-compatible replica of the function
- which will raise a ``PendingDeprecationWarning``. This warning is silent
- by default; you need to explicitly turn on display of these warnings.
+* Django 1.5 will contain a backwards-compatible replica of the function which
+ will raise a ``PendingDeprecationWarning``. This warning is silent by
+ default; you can turn on display of these warnings with the ``-Wd`` option
+ of Python.
-* Django 1.2 will contain the backwards-compatible replica, but the warning
+* Django 1.6 will contain the backwards-compatible replica, but the warning
will be promoted to a full-fledged ``DeprecationWarning``. This warning is
*loud* by default, and will likely be quite annoying.
-* Django 1.3 will remove the feature outright.
+* Django 1.7 will remove the feature outright.
Micro releases
--------------
-Micro releases (1.0.1, 1.0.2, 1.1.1, etc.) will be issued at least once half-way
-between minor releases, and probably more often as needed.
+Micro releases (1.5.1, 1.6.2, 1.6.1, etc.) will be issued as needed, often to
+fix security issues.
These releases will be 100% compatible with the associated minor release, unless
this is impossible for security reasons. So the answer to "should I upgrade to
the latest micro release?" will always be "yes."
-Each minor release of Django will have a "release maintainer" appointed. This
-person will be responsible for making sure that bug fixes are applied to both
-trunk and the maintained micro-release branch. This person will also work with
-the release manager to decide when to release the micro releases.
-
.. _backwards-compatibility-policy:
Supported versions
@@ -96,10 +91,10 @@ Supported versions
At any moment in time, Django's developer team will support a set of releases to
varying levels:
-* The current development trunk will get new features and bug fixes
+* The current development master will get new features and bug fixes
requiring major refactoring.
-* Patches applied to the trunk will also be applied to the last minor
+* Patches applied to the master branch must also be applied to the last minor
release, to be released as the next micro release, when they fix critical
problems:
@@ -111,40 +106,42 @@ varying levels:
* Major functionality bugs in newly-introduced features.
- The rule of thumb is that fixes will be backported to the last minor
- release for bugs that would have prevented a release in the first place.
+ The rule of thumb is that fixes will be backported to the last minor release
+ for bugs that would have prevented a release in the first place (release
+ blockers).
-* Security fixes will be applied to the current trunk and the previous two
+* Security fixes will be applied to the current master and the previous two
minor releases.
+* Committers may choose to backport bugfixes at their own discretion,
+ provided they do not introduce backwards incompatibilities.
+
* Documentation fixes generally will be more freely backported to the last
- release branch, at the discretion of the committer, and they don't need to
- meet the "critical fixes only" bar. That's because it's highly advantageous
- to have the docs for the last release be up-to-date and correct, and the
- downside of backporting (risk of introducing regressions) is much less of a
- concern.
+ release branch. That's because it's highly advantageous to have the docs for
+ the last release be up-to-date and correct, and the risk of introducing
+ regressions is much less of a concern.
As a concrete example, consider a moment in time halfway between the release of
-Django 1.3 and 1.4. At this point in time:
+Django 1.6 and 1.7. At this point in time:
-* Features will be added to development trunk, to be released as Django 1.4.
+* Features will be added to development master, to be released as Django 1.7.
-* Critical bug fixes will be applied to a ``1.3.X`` branch, and released as
- 1.3.1, 1.3.2, etc.
+* Critical bug fixes will be applied to the ``stable/1.6.X`` branch, and
+ released as 1.6.1, 1.6.2, etc.
-* Security fixes will be applied to trunk, a ``1.3.X`` branch and a
- ``1.2.X`` branch. They will trigger the release of ``1.3.1``, ``1.2.1``,
- etc.
+* Security fixes will be applied to ``master``, to the ``stable/1.6.X``
+ branch, and to the ``stable/1.5.X`` branch. They will trigger the release of
+ ``1.6.1``, ``1.5.1``, etc.
-* Documentation fixes will be applied to trunk, and, if easily backported, to
- the ``1.3.X`` branch.
+* Documentation fixes will be applied to master, and, if easily backported, to
+ the ``1.6.X`` branch. Bugfixes may also be backported.
.. _release-process:
Release process
===============
-Django uses a time-based release schedule, with minor (i.e. 1.1, 1.2, etc.)
+Django uses a time-based release schedule, with minor (i.e. 1.6, 1.7, etc.)
releases every nine months, or more, depending on features.
After each release, and after a suitable cooling-off period of a few weeks, the
@@ -190,45 +187,56 @@ At the end of phase two, any unfinished "maybe" features will be postponed until
the next release. Though it shouldn't happen, any "must-have" features will
extend phase two, and thus postpone the final release.
-Phase two will culminate with an alpha release.
+Phase two will culminate with an alpha release. At this point, the
+``stable/A.B.x`` branch will be forked from ``master``.
Phase three: bugfixes
~~~~~~~~~~~~~~~~~~~~~
The last third of a release is spent fixing bugs -- no new features will be
-accepted during this time. We'll release a beta release about halfway through,
-and an rc complete with string freeze two weeks before the end of the schedule.
+accepted during this time. We'll try to release a beta release after one month
+and a release candidate after two months.
+
+The release candidate marks the string freeze, and it happens at least two
+weeks before the final release. After this point, new translatable strings
+must not be added.
+
+During this phase, committers will be more and more conservative with
+backports, to avoid introducing regressions. After the release candidate, only
+release blockers and documentation fixes should be backported.
+
+In parallel to this phase, ``master`` can receive new features, to be released
+in the ``A.B+1`` cycle.
Bug-fix releases
----------------
-After a minor release (e.g. 1.1), the previous release will go into bugfix
+After a minor release (e.g. 1.6), the previous release will go into bugfix
mode.
-A branch will be created of the form ``branches/releases/1.0.X`` to track
-bugfixes to the previous release. Critical bugs fixed on trunk must
-*also* be fixed on the bugfix branch; this means that commits need to cleanly
-separate bug fixes from feature additions. The developer who commits a fix to
-trunk will be responsible for also applying the fix to the current bugfix
-branch. Each bugfix branch will have a maintainer who will work with the
-committers to keep them honest on backporting bug fixes.
+A branch will be created of the form ``stable/1.5.x`` to track bugfixes to the
+previous release. Critical bugs fixed on master must *also* be fixed on the
+bugfix branch; this means that commits need to cleanly separate bug fixes from
+feature additions. The developer who commits a fix to master will be
+responsible for also applying the fix to the current bugfix branch.
How this all fits together
--------------------------
Let's look at a hypothetical example for how this all first together. Imagine,
-if you will, a point about halfway between 1.1 and 1.2. At this point,
+if you will, a point about halfway between 1.5 and 1.6. At this point,
development will be happening in a bunch of places:
-* On trunk, development towards 1.2 proceeds with small additions, bugs
+* On master, development towards 1.6 proceeds with small additions, bugs
fixes, etc. being checked in daily.
-* On the branch "branches/releases/1.1.X", fixes for critical bugs found in
- the 1.1 release are checked in as needed. At some point, this branch will
- be released as "1.1.1", "1.1.2", etc.
+* On the branch ``stable/1.5.x``, fixes for critical bugs found in
+ the 1.5 release are checked in as needed. At some point, this branch will
+ be released as "1.5.1", "1.5.2", etc.
-* On the branch "branches/releases/1.0.X", security fixes are made if
- needed and released as "1.0.2", "1.0.3", etc.
+* On the branch ``stable/1.4.x``, security fixes are made if
+ needed and released as "1.4.2", "1.4.3", etc.
-* On feature branches, development of major features is done. These
- branches will be merged into trunk before the end of phase two.
+* Development of major features is done in branches in forks of the main
+ repository. These branches will be merged into ``master`` before "1.6
+ alpha 1".