test0908
/
django
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Updated the release process docs to reflect the current practices. 

Fixed #17919.
This commit is contained in:
Aymeric Augustin 2013-02-24 11:38:34 +01:00
parent f1255a3c09
commit 5d883589a8
1 changed files with 82 additions and 74 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

156
docs/internals/release-process.txt
View File

@ -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 * ``A`` is the *major version* number, which is only incremented for major
changes to Django, and these changes are not necessarily 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. when we release Django 2.0.
* ``B`` is the *minor version* number, which is incremented for large yet * ``B`` is the *minor version* number, which is incremented for large yet
backwards compatible changes. Code written for Django 1.2 will continue backwards compatible changes. Code written for Django 1.6 will continue
to work under Django 1.3. Exceptions to this rule will be listed in the to work under Django 1.7. Exceptions to this rule will be listed in the
release notes. release notes.
* ``C`` is the *micro version* number, which is incremented for bug and * ``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, can't be fixed without breaking backwards-compatibility. If this happens,
the release notes will provide detailed upgrade instructions. the release notes will provide detailed upgrade instructions.
* In some cases, we'll make alpha, beta, or release candidate releases. * Before a new minor release, we'll make alpha, beta, and release candidate
These are of the form ``A.B alpha/beta/rc N``, which means the ``Nth`` releases. These are of the form ``A.B alpha/beta/rc N``, which means the
alpha/beta/release candidate of version ``A.B``. ``Nth`` alpha/beta/release candidate of version ``A.B``.
In git, each Django release will have a tag indicating its version In git, each Django release will have a tag indicating its version number,
number, signed with the Django release key. Additionally, each release signed with the Django release key. Additionally, each release series has its
series (X.Y) has its own branch, and bugfix/security releases will be own branch, called ``stable/A.B.x``, and bugfix/security releases will be
issued from those branches. issued from those branches.
For more information about how the Django project issues new releases For more information about how the Django project issues new releases for
for security purposes, please see :doc:`our security policies security purposes, please see :doc:`our security policies <security>`.
<security>`.
Major releases Major releases
-------------- --------------
Major releases (1.0, 2.0, etc.) will happen very infrequently (think "years", 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 releases
-------------- --------------
Minor release (1.1, 1.2, etc.) will happen roughly every nine months -- see Minor release (1.5, 1.6, etc.) will happen roughly every nine months -- see
`release process`_, below for details. `release process`_, below for details. These releases will contain new
features, improvements to existing features, and such.
.. _internal-release-deprecation-policy: .. _internal-release-deprecation-policy:
These releases will contain new features, improvements to existing features, and A minor release may deprecate certain features from previous releases. If a
such. 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
feature in version ``A.B`` is deprecated, it will continue to work in version ``A.B`` and ``A.B+1`` but raise warnings. It will be removed in version
``A.B+1``. In version ``A.B+2``, use of the feature will raise a ``A.B+2``.
``DeprecationWarning`` but will continue to work. Version ``A.B+3`` will
remove the feature entirely.
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 * Django 1.5 will contain a backwards-compatible replica of the function which
which will raise a ``PendingDeprecationWarning``. This warning is silent will raise a ``PendingDeprecationWarning``. This warning is silent by
by default; you need to explicitly turn on display of these warnings. 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 will be promoted to a full-fledged ``DeprecationWarning``. This warning is
*loud* by default, and will likely be quite annoying. *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
-------------- --------------
Micro releases (1.0.1, 1.0.2, 1.1.1, etc.) will be issued at least once half-way Micro releases (1.5.1, 1.6.2, 1.6.1, etc.) will be issued as needed, often to
between minor releases, and probably more often as needed. fix security issues.
These releases will be 100% compatible with the associated minor release, unless 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 this is impossible for security reasons. So the answer to "should I upgrade to
the latest micro release?" will always be "yes." 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: .. _backwards-compatibility-policy:
Supported versions Supported versions
@ -96,10 +91,10 @@ Supported versions
At any moment in time, Django's developer team will support a set of releases to At any moment in time, Django's developer team will support a set of releases to
varying levels: 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. 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 release, to be released as the next micro release, when they fix critical
problems: problems:
@ -111,40 +106,42 @@ varying levels:
* Major functionality bugs in newly-introduced features. * Major functionality bugs in newly-introduced features.
The rule of thumb is that fixes will be backported to the last minor The rule of thumb is that fixes will be backported to the last minor release
release for bugs that would have prevented a release in the first place. 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. 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 * 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 release branch. That's because it's highly advantageous to have the docs for
meet the "critical fixes only" bar. That's because it's highly advantageous the last release be up-to-date and correct, and the risk of introducing
to have the docs for the last release be up-to-date and correct, and the regressions is much less of a concern.
downside of backporting (risk of introducing regressions) is much less of a
concern.
As a concrete example, consider a moment in time halfway between the release of 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 * Critical bug fixes will be applied to the ``stable/1.6.X`` branch, and
1.3.1, 1.3.2, etc. released as 1.6.1, 1.6.2, etc.
* Security fixes will be applied to trunk, a ``1.3.X`` branch and a * Security fixes will be applied to ``master``, to the ``stable/1.6.X``
``1.2.X`` branch. They will trigger the release of ``1.3.1``, ``1.2.1``, branch, and to the ``stable/1.5.X`` branch. They will trigger the release of
etc. ``1.6.1``, ``1.5.1``, etc.
* Documentation fixes will be applied to trunk, and, if easily backported, to * Documentation fixes will be applied to master, and, if easily backported, to
the ``1.3.X`` branch. the ``1.6.X`` branch. Bugfixes may also be backported.
.. _release-process: .. _release-process:
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. releases every nine months, or more, depending on features.
After each release, and after a suitable cooling-off period of a few weeks, the 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 the next release. Though it shouldn't happen, any "must-have" features will
extend phase two, and thus postpone the final release. 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 Phase three: bugfixes
~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~
The last third of a release is spent fixing bugs -- no new features will be 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, accepted during this time. We'll try to release a beta release after one month
and an rc complete with string freeze two weeks before the end of the schedule. 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 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. mode.
A branch will be created of the form ``branches/releases/1.0.X`` to track A branch will be created of the form ``stable/1.5.x`` to track bugfixes to the
bugfixes to the previous release. Critical bugs fixed on trunk must previous release. Critical bugs fixed on master must *also* be fixed on the
*also* be fixed on the bugfix branch; this means that commits need to cleanly bugfix branch; this means that commits need to cleanly separate bug fixes from
separate bug fixes from feature additions. The developer who commits a fix to feature additions. The developer who commits a fix to master will be
trunk will be responsible for also applying the fix to the current bugfix responsible for also applying the fix to the current bugfix branch.
branch. Each bugfix branch will have a maintainer who will work with the
committers to keep them honest on backporting bug fixes.
How this all fits together How this all fits together
-------------------------- --------------------------
Let's look at a hypothetical example for how this all first together. Imagine, 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: 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. fixes, etc. being checked in daily.
* On the branch "branches/releases/1.1.X", fixes for critical bugs found in * On the branch ``stable/1.5.x``, fixes for critical bugs found in
the 1.1 release are checked in as needed. At some point, this branch will the 1.5 release are checked in as needed. At some point, this branch will
be released as "1.1.1", "1.1.2", etc. be released as "1.5.1", "1.5.2", etc.
* On the branch "branches/releases/1.0.X", security fixes are made if * On the branch ``stable/1.4.x``, security fixes are made if
needed and released as "1.0.2", "1.0.3", etc. needed and released as "1.4.2", "1.4.3", etc.
* On feature branches, development of major features is done. These * Development of major features is done in branches in forks of the main
branches will be merged into trunk before the end of phase two. repository. These branches will be merged into ``master`` before "1.6
alpha 1".