PageRenderTime 391ms CodeModel.GetById 37ms RepoModel.GetById 8ms app.codeStats 0ms

Plain Text | 205 lines | 145 code | 60 blank | 0 comment | 0 complexity | 9a8121edc09fd30fa59807b8647ef668 MD5 | raw file
Possible License(s): BSD-3-Clause
  1. ========================
  2. Django's release process
  3. ========================
  4. .. _official-releases:
  5. Official releases
  6. =================
  7. Django's release numbering works as follows:
  8. * Versions are numbered in the form ``A.B`` or ``A.B.C``.
  9. * ``A`` is the *major version* number, which is only incremented for major
  10. changes to Django, and these changes are not necessarily
  11. backwards-compatible. That is, code you wrote for Django 6.0 may break
  12. when we release Django 7.0.
  13. * ``B`` is the *minor version* number, which is incremented for large yet
  14. backwards compatible changes. Code written for Django 6.4 will continue
  15. to work under Django 6.5.
  16. * ``C`` is the *micro version* number which, is incremented for bug and
  17. security fixes. A new micro-release will always be 100%
  18. backwards-compatible with the previous micro-release.
  19. * In some cases, we'll make alpha, beta, or release candidate releases.
  20. These are of the form ``A.B alpha/beta/rc N``, which means the ``Nth``
  21. alpha/beta/release candidate of version ``A.B``.
  22. An exception to this version numbering scheme is the pre-1.0 Django code.
  23. There's no guarantee of backwards-compatibility until the 1.0 release.
  24. In Subversion, each Django release will be tagged under ``tags/releases``. If
  25. it's necessary to release a bug fix release or a security release that doesn't
  26. come from the trunk, we'll copy that tag to ``branches/releases`` to make the
  27. bug fix release.
  28. Major releases
  29. --------------
  30. Major releases (1.0, 2.0, etc.) will happen very infrequently (think "years",
  31. not "months"), and will probably represent major, sweeping changes to Django.
  32. Minor releases
  33. --------------
  34. Minor release (1.1, 1.2, etc.) will happen roughly every nine months -- see
  35. `release process`_, below for details.
  36. .. _internal-release-deprecation-policy:
  37. These releases will contain new features, improvements to existing features, and
  38. such. A minor release may deprecate certain features from previous releases. If a
  39. feature in version ``A.B`` is deprecated, it will continue to work in version
  40. ``A.B+1``. In version ``A.B+2``, use of the feature will raise a
  41. ``DeprecationWarning`` but will continue to work. Version ``A.B+3`` will
  42. remove the feature entirely.
  43. So, for example, if we decided to remove a function that existed in Django 1.0:
  44. * Django 1.1 will contain a backwards-compatible replica of the function
  45. which will raise a ``PendingDeprecationWarning``. This warning is silent
  46. by default; you need to explicitly turn on display of these warnings.
  47. * Django 1.2 will contain the backwards-compatible replica, but the warning
  48. will be promoted to a full-fledged ``DeprecationWarning``. This warning is
  49. *loud* by default, and will likely be quite annoying.
  50. * Django 1.3 will remove the feature outright.
  51. Micro releases
  52. --------------
  53. Micro releases (1.0.1, 1.0.2, 1.1.1, etc.) will be issued at least once half-way
  54. between minor releases, and probably more often as needed.
  55. These releases will always be 100% compatible with the associated minor release
  56. -- the answer to "should I upgrade to the latest micro release?" will always be
  57. "yes."
  58. Each minor release of Django will have a "release maintainer" appointed. This
  59. person will be responsible for making sure that bug fixes are applied to both
  60. trunk and the maintained micro-release branch. This person will also work with
  61. the release manager to decide when to release the micro releases.
  62. Supported versions
  63. ==================
  64. At any moment in time, Django's developer team will support a set of releases to
  65. varying levels:
  66. * The current development trunk will get new features and bug fixes
  67. requiring major refactoring.
  68. * All bug fixes applied to the trunk will also be applied to the last
  69. minor release, to be released as the next micro release.
  70. * Security fixes will be applied to the current trunk and the previous two
  71. minor releases.
  72. As a concrete example, consider a moment in time halfway between the release of
  73. Django 1.3 and 1.4. At this point in time:
  74. * Features will be added to development trunk, to be released as Django 1.4.
  75. * Bug fixes will be applied to a ``1.3.X`` branch, and released as 1.3.1,
  76. 1.3.2, etc.
  77. * Security releases will be applied to trunk, a ``1.3.X`` branch and a
  78. ``1.2.X`` branch. Security fixes will trigger the release of ``1.3.1``,
  79. ``1.2.1``, etc.
  80. .. _release-process:
  81. Release process
  82. ===============
  83. Django uses a time-based release schedule, with minor (i.e. 1.1, 1.2, etc.)
  84. releases every nine months, or more, depending on features.
  85. After each previous release (and after a suitable cooling-off period of a week
  86. or two), the core development team will examine the landscape and announce a
  87. timeline for the next release. Most releases will be scheduled in the 6-9 month
  88. range, but if we have bigger features to development we might schedule a longer
  89. period to allow for more ambitious work.
  90. Release cycle
  91. -------------
  92. Each release cycle will be split into three periods, each lasting roughly
  93. one-third of the cycle:
  94. Phase one: feature proposal
  95. ~~~~~~~~~~~~~~~~~~~~~~~~~~~
  96. The first phase of the release process will be devoted to figuring out what
  97. features to include in the next version. This should include a good deal of
  98. preliminary work on those features -- working code trumps grand design.
  99. At the end of part one, the core developers will propose a feature list for the
  100. upcoming release. This will be broken into:
  101. * "Must-have": critical features that will delay the release if not finished
  102. * "Maybe" features: that will be pushed to the next release if not finished
  103. * "Not going to happen": features explicitly deferred to a later release.
  104. Anything that hasn't got at least some work done by the end of the first third
  105. isn't eligible for the next release; a design alone isn't sufficient.
  106. Phase two: development
  107. ~~~~~~~~~~~~~~~~~~~~~~
  108. The second third of the release schedule is the "heads-down" working period.
  109. Using the roadmap produced at the end of phase one, we'll all work very hard to
  110. get everything on it done.
  111. Longer release schedules will likely spend more than a third of the time in this
  112. phase.
  113. At the end of phase two, any unfinished "maybe" features will be postponed until
  114. the next release. Though it shouldn't happen, any "must-have" features will
  115. extend phase two, and thus postpone the final release.
  116. Phase two will culminate with an alpha release.
  117. Phase three: bugfixes
  118. ~~~~~~~~~~~~~~~~~~~~~
  119. The last third of a release is spent fixing bugs -- no new features will be
  120. accepted during this time. We'll release a beta release about halfway through,
  121. and an rc complete with string freeze two weeks before the end of the schedule.
  122. Bug-fix releases
  123. ----------------
  124. After a minor release (i.e 1.1), the previous release will go into bug-fix mode.
  125. A branch will be created of the form ``branches/releases/1.0.X`` to track
  126. bug-fixes to the previous release. When possible, bugs fixed on trunk must
  127. *also* be fixed on the bug-fix branch; this means that commits need to cleanly
  128. separate bug fixes from feature additions. The developer who commits a fix to
  129. trunk will be responsible for also applying the fix to the current bug-fix
  130. branch. Each bug-fix branch will have a maintainer who will work with the
  131. committers to keep them honest on backporting bug fixes.
  132. How this all fits together
  133. --------------------------
  134. Let's look at a hypothetical example for how this all first together. Imagine,
  135. if you will, a point about halfway between 1.1 and 1.2. At this point,
  136. development will be happening in a bunch of places:
  137. * On trunk, development towards 1.2 proceeds with small additions, bugs
  138. fixes, etc. being checked in daily.
  139. * On the branch "branches/releases/1.1.X", bug fixes found in the 1.1
  140. release are checked in as needed. At some point, this branch will be
  141. released as "1.1.1", "1.1.2", etc.
  142. * On the branch "branches/releases/1.0.X", security fixes are made if
  143. needed and released as "1.0.2", "1.0.3", etc.
  144. * On feature branches, development of major features is done. These
  145. branches will be merged into trunk before the end of phase two.